Skip to content

Latest commit

 

History

History
58 lines (35 loc) · 3.66 KB

CONTRIBUTING.md

File metadata and controls

58 lines (35 loc) · 3.66 KB

Xesar-Connect Contribution Guidelines

Thank you for considering contributing to the Xesar-Connect project! Contributions from the community help improve the library and make it even more valuable for users. Please take a moment to review these guidelines before making your contribution.

How to Contribute

  1. Fork the Repository: Start by forking the Xesar-Connect repository to your GitHub account. You can do this by clicking the "Fork" button on the top-right corner of the repository page.

  2. Clone the Fork: Clone the forked repository to your local machine using the following command:

    git clone https://github.com/open200/xesar-connect.git

  3. Create a Branch: Create a new branch for your contribution. Use a descriptive name that indicates the nature of your changes:

    git checkout -b feature/new-feature

  4. Make Changes: Make the necessary changes to the codebase in your branch. Ensure that your changes align with the project's goals and guidelines.

  5. Test: If your changes involve code, ensure that your code compiles and runs without errors. If possible, include unit tests to verify the functionality of your changes.

  6. Commit and Push: Commit your changes and push the changes to your forked repository:

    git commit -m "Add new feature"
git push origin feature/new-feature

  7. Open a Pull Request (PR): Open a pull request from your branch to the main Xesar-Connect repository. Provide a clear and concise description of your changes. Reference any relevant issues if applicable.

  8. Code Review: Your PR will be reviewed by project maintainers. They may provide feedback and suggest changes if needed. Be responsive to their comments and address any concerns.

  9. Merge: Once your changes are approved, they will be merged into the main repository. Congratulations, you've successfully contributed to Xesar-Connect!

Contribution Guidelines

  • Be Respectful: Treat other contributors, maintainers, and users with respect and professionalism. Healthy discussions and disagreements are encouraged, but avoid personal attacks.

  • Code Style: Follow the existing code style of the project to ensure consistency. If possible, adhere to Kotlin coding conventions.

  • Commit Style: For the commit messages, use the Angular Conventional Commits rules set. In addition, the very last part of the commit message should be a link to the GitHub issue. Use the format: Closes: <Issues in the repository>

  • Documentation: If your contribution involves code changes, update the documentation accordingly. Clear documentation helps users understand the changes and how to use the new features.

  • Testing: Whenever possible, include unit tests for the code changes you're making. Tests help ensure the stability of the codebase and prevent regressions.

  • Issues and PRs: Before starting work on a new feature or issue, check if there's already an open issue or PR related to it. Coordinate and collaborate with others to avoid duplication of effort.

  • Breaking Changes: If you're making substantial changes that could affect existing users, please provide clear documentation about the changes and any migration steps required.

  • Stay Updated: Keep an eye on the project's issue tracker and discussions to stay updated on ongoing development and upcoming features.

License

By contributing to Xesar-Connect, you agree that your contributions will be licensed under the Apache 2.0 License.

Thank you for your interest in contributing to Xesar-Connect! Your contributions are greatly appreciated.