pk
/
cosmium
mirror of https://github.com/pikami/cosmium.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
cosmium/docs/CONTRIBUTING.md

2.6 KiB
Raw Blame History

Contributing to Cosmium

Thank you for considering contributing to Cosmium! We appreciate your interest in helping to improve our project.

Please note that by participating in this project, you agree to abide by our Code of Conduct. We expect all contributors to uphold the principles of respect, inclusivity, and professionalism.

If you have any questions or need assistance with the contribution process, feel free to reach out to us by opening an issue or contacting the maintainers directly.

We look forward to your contributions! 🚀

Finding ways to contribute

A great way to contribute is to scan the Compatibility Matrix for unsupported features and improving compatibility with CosmosDB.

A part from that, the Issues page might contain issues registered by other users. Fixing reported issues is a great way to contribute.

How to Contribute

  1. Create an Issue: Before starting work on a new feature or bug fix, please create an issue or look for existing ones on the Issues page to discuss your proposed changes. This allows us to provide feedback and ensure that your contribution aligns with the project goals.

  2. Fork the Repository: Once you have identified an issue to work on, fork the repository to your own GitHub account.

  3. Create a Branch: Create a new branch for your changes using a descriptive name that reflects the issue you are addressing.

  4. Commit Changes: Commit your changes with clear and descriptive commit messages. Reference the issue number in the commit message. Please write unit tests for your implemented feature!

  5. Create a Pull Request: Once your changes are ready, create a pull request from your forked repository to the main repository. Be sure to include a detailed description of your changes and reference the relevant issue.

  6. Review and Collaborate: Participate in the code review process by addressing any feedback or comments from maintainers. Collaboration and constructive feedback help ensure the quality of contributions.

Example Commits

To get an idea of how to implement new query functions, you can review the following example commits: