Contributing to Xprofile 💖
Thank you for considering contributing to this repository! This guide will walk you through how to do so successfully.
You should read GitHub's general guidance on contributing to projects and guidance on collaborating with pull requests.
Before submitting any changes, document them in an issue. For example, this might be a feature request issue for the feature you will create or a bug report for the bug you will fix. If the issue already exists, e.g. a bug report for the same bug you'll fix or a feature request for the same feature you're building, skip this step. Don't make a duplicate issue.
To start work on your changes to be submitted, fork and clone this library. You should then create a new branch on your fork dedicated to the changes you're making. You should read GitHub's docs about branches. Make sure you use a separate branch (⇒ PR) for each change (e.g. adding one feature or fixing one bug) you are making. If you want to make multiple, do so in separate branches, and submit them in separate PRs. Otherwise, your PRs will bloat, and it will be hard to review, manage, and keep track of them.
Once you have ensured your changes work as required, commit your changes and push them to your fork.
Once you've done these, you're ready to submit a Pull Request (PR).
To submit your changes for review and to have them added to this library, you must make a pull request (PR).
Ensure the link the issue you made earlier (and any others that are relevant) to your PR.
PRs should be made against and merged into
the main
branch, which is set as the default branch on GitHub.
You can also make a draft PR if you need feedback on your changes early on and before finalizing for merging.
Once you have made a PR, you will then get feedback from the maintainers of the repo. This will help ensure your changes are ready to be merged.
Happy coding 🚀 🚀