Skip to content

Latest commit

 

History

History
43 lines (22 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

43 lines (22 loc) · 2.64 KB

Contributing Guidelines

Thank you for considering contributing to the tazer! By contributing, you help improve the tool and make it more useful for the osu! community. Here are some guidelines to follow when contributing:

Code of Conduct

Please note that this project follows an Code of Conduct. We expect all contributors to adhere to this code when participating in the project.

How Can I Contribute?

There are several ways you can contribute to tazer:

  1. Bug Reports: If you encounter any issues or bugs while using the tool, please open an issue on GitHub. Provide detailed information about the problem, including steps to reproduce it.

  2. Feature Requests: If you have an idea for a new feature or improvement, you can submit a feature request. Describe the feature or enhancement you have in mind and why it would be valuable.

  3. Code Contributions: If you're a developer and would like to contribute code to the project, feel free to fork the repository and submit a pull request. Please adhere to the coding standards and guidelines outlined below.

Code Contributions

When submitting code contributions, please follow these guidelines:

  1. Fork the Repository: Fork the tazer repository to your GitHub account.

  2. Branch Naming: Create a descriptive branch name that reflects the purpose of your changes. For example, use feature/my-new-feature or bugfix/fix-issue-123.

  3. Coding Standards: Follow the coding style and standards of the project. Ensure your code is well-documented, and variable and function names are clear and descriptive.

  4. Testing: If you are adding a new feature or fixing a bug, write unit tests where applicable. Ensure that existing tests pass successfully.

  5. Commit Messages: Write clear and concise commit messages that describe the purpose of each commit. Use the present tense and be specific.

  6. Pull Requests: Submit a pull request from your forked repository to the main project repository. Provide a clear description of the changes you've made in the pull request.

  7. Code Review: Be prepared to participate in the code review process. Address any feedback or comments promptly and make necessary revisions.

  8. Squash Commits: If you make multiple commits for a single feature or bug fix, consider squashing them into a single commit for clarity.

Licensing

By contributing to tazer, you agree that your contributions will be licensed under the MPL-2.0 License.

Thank you for your contributions and support in making this tool better for the osu! community!