Skip to content

Latest commit

 

History

History
33 lines (21 loc) · 1.4 KB

contributing.md

File metadata and controls

33 lines (21 loc) · 1.4 KB

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. Make sure to 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.

Fork and Pull Request (PR) Workflow

  1. Fork the Repository: Fork the repository on GitHub and clone your fork to your local machine.
  2. Create a Branch: Create a new branch for your changes.
  3. Make Changes: Make your changes in the new branch.
  4. Submit a PR: Push your changes to your fork and submit a pull request (PR) to the develop branch of the original repository.

Reviewing and Merging

  • 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 develop branch, and subsequently, the main branch as part of our release process.

Thank you!

Thank you for contributing to xRx!