Skip to main content

Contributing to xRx

First off, thank you for considering contributing to xRx! It's people like you that make this project great.

The following is a set of guidelines for contributing to xRx. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How to Contribute​

Reporting Issues​

If you encounter a bug or have a feature request, please create an issue on GitHub. When creating an issue, please include:

  • A clear and descriptive title
  • A detailed description of the issue or feature request
  • Steps to reproduce the issue (if applicable)
  • Any relevant screenshots, logs, or code snippets

Contributing Code​

We welcome contributions to the xRx framework and its sample applications. If you have any suggestions or improvements, please follow these steps:

  1. Open a new issue on GitHub describing the proposed change or improvement
  2. Fork the repository
  3. Create a new branch for your feature
  4. Commit your changes
  5. Push to your branch
  6. Create a pull request, referencing the issue you created

Note: Pull requests not backed by published issues may not be considered. This process ensures that all contributions are discussed and aligned with the project's goals before implementation.

Code Review Process​

  • Your pull request will be reviewed by a project maintainer
  • You may be asked to make changes to your pull request based on feedback
  • Once your pull request is approved, it will be merged into the main branch

Coding Standards​

To maintain consistency across the project, please adhere to the following guidelines:

  • Follow the existing code style and formatting
  • Write clear, descriptive commit messages
  • Include comments in your code where necessary
  • Write and update tests for your changes

Community Guidelines​

We strive to maintain a welcoming and inclusive community. Please:

  • Be respectful and considerate in your interactions with other contributors
  • Provide constructive feedback
  • Be open to suggestions and improvements

Thank You!​

Your contributions play a vital role in the growth and improvement of xRx. We truly appreciate your efforts and look forward to your contributions!