Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
- For Feature Requests and feedback; start a Discussion about your proposed changes.
- If Feature Requests or feedback is approved; create a new issue! Please try to be as descriptive as possible.
- Declare your intent to work on the issue you intend to work on.
- Fork the repository so you have a copy on your GitHub profile
- Clone the repository to your local machine
git clone <REPO URL>
- Create a
feature
branch off of thedev
branch.git switch -c feature dev
- Make sure to have atomic commits and contextual commit messages using Emoji-Log for both the commit messages, and pull request titles.
- Keep Pull Requests small in scope (like a single feature per PR) to make approval and refactoring easier.
- Push your local
feature
branch to your remote repository on GitHubgit push -u origin feature
- Open a new merge/pull request and in your pull request reference the issue the pull request is for by it's number, ex:
resolves #11
- Pull Request must pass Linting, Unit Tests, and any other checks for a passing build to be considered ready for manual review and feedback.
- After review and feedback and any requested changes have been made, the pull request will be merged with the
dev
branch and be a part of the next release toprod
I'll try to be as responsive as possible in reviewing and accepting pull requests. I appreciate your contributions very much!