Skip to content

Latest commit

 

History

History
78 lines (42 loc) · 3.4 KB

CONTRIBUTING.md

File metadata and controls

78 lines (42 loc) · 3.4 KB
Raw

Contributing to Synon

Thank you for considering contributing to the Synon project! We welcome contributions from the community to help improve and grow the library. By contributing, you can help make a positive impact on the project and assist fellow developers in utilizing Synon effectively.

Code of Conduct

Before contributing, please review our Code of Conduct to understand the expected behavior and guidelines for interacting within the Synon community.

Ways to Contribute

You can contribute to Synon in various ways, including but not limited to:

  • Reporting issues: If you encounter a bug, have a feature request, or have any suggestions for improvement, please submit an issue on the GitHub repository. Provide as much detail as possible to help us understand and address the matter effectively.

  • Bug fixes and feature enhancements: If you have the technical skills and knowledge, you can contribute by submitting pull requests with bug fixes or new features. Please refer to the guidelines below for the development workflow and coding conventions.

  • Documentation improvements: Enhancing the documentation is valuable for making Synon more accessible to users. If you spot any gaps, errors, or areas that need clarification, feel free to submit a pull request to improve the documentation.

Development Workflow

To contribute code changes to Synon, follow these steps:

  1. Fork the Synon repository to your own GitHub account.

  2. Clone the forked repository to your local development environment.

  3. Create a new branch for your changes:

    git checkout -b my-feature

  4. Make the necessary changes and additions to the codebase.

  5. Test your changes to ensure they work as expected and do not introduce any regressions.

  6. Commit your changes with a clear and descriptive commit message:

    git commit -m "Add my feature"

  7. Push your changes to your forked repository:

    git push origin my-feature

  8. Open a pull request against the main Synon repository on GitHub. Provide a clear description of the changes and the rationale behind them.

  9. Participate in the review process, address any feedback, and make further changes if necessary.

  10. Once your pull request is approved and merged, your contributions will become part of the Synon project.

Coding Conventions

When contributing code to Synon, please adhere to the following conventions:

  • Follow the existing code style and formatting to maintain consistency.

  • Write clear and descriptive comments to explain the code's intent and functionality.

  • Ensure that your code is well-documented, especially for new features or significant changes.

  • Write meaningful commit messages that summarize the changes you made.

  • Before submitting a pull request, run the necessary tests to ensure that the changes do not introduce any regressions.

Communication

If you have any questions, concerns, or need guidance while contributing to Synon, feel free to reach out to the project maintainers via [email address or contact method]. We are here to assist and support you throughout the process.

We appreciate your contributions and look forward to working with you to make Synon even better!

License

By contributing to the Synon project, you agree that your contributions will be licensed under the LICENSE of the project.