Skip to content

Adding contribution guidelines #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lietu merged 2 commits into from
Apr 10, 2025
Merged

Adding contribution guidelines #85

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
68d7cb8
Adding CONTRIBUTING.md
lietu Apr 10, 2025
31471fb
pre-commit
lietu Apr 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Contributing to this project

Thank you for your interest in contributing! We welcome contributions of all kinds, from
bug reports to new features. This document outlines our guidelines to make the process
smooth and effective.

## Code of Conduct

We are committed to providing a welcoming and respectful community for everyone. We
expect all contributors to adhere to a high standard of conduct. **Harassment, abusive
language, discrimination (including but not limited to racism, sexism, homophobia,
transphobia, ableism, or any other form of prejudice) will not be tolerated.**
Violations may result in removal from the project and/or reporting.

## How to contribute

1. **Discuss first:** Before tackling a significant change or feature, please open an
issue to discuss your idea. This helps ensure it aligns with the project's goals and
avoids wasted effort.

2. **Code style & formatting:** We aim for consistent code style throughout the project.

- Please run any automated formatting tools included in this repository (e.g.,
`pre-commit`, `prettier`, `ruff`, `go fmt`). Check the `.editorconfig` or build
scripts for details.
- Try to follow existing coding conventions within the codebase.

3. **Submit a pull request:** When you're ready to contribute:

- Create a pull request against the `main` branch.
- In your PR description, _clearly explain_:
- **What changed?** A concise summary of your changes.
- **Why did you make this change?** What problem does it solve or what improvement
does it offer?
- **Output Changes (if applicable):** If your changes affect the output of the
project (e.g., UI, logs), please include screenshots _before and after_ to
illustrate the impact.

4. **Be patient:** We are a small team with limited time dedicated to managing this
repository. We will review pull requests as quickly as possible, but it may take some
time. Your patience is greatly appreciated!

Thanks again for your contribution!