Skip to content
This repository has been archived by the owner on Aug 8, 2024. It is now read-only.

Latest commit

 

History

History
50 lines (32 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

50 lines (32 loc) · 2 KB

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.


Types of Contributions


Bug Reports, Feature Requests, and Feedback


  1. For Feature Requests and feedback; start a Discussion about your proposed changes.
  2. If Feature Requests or feedback is approved; create a new issue! Please try to be as descriptive as possible.

BugFixes, New Features and Documentation


  1. Declare your intent to work on the issue you intend to work on.
  2. Fork the repository so you have a copy on your GitHub profile
  3. Clone the repository to your local machine git clone <REPO URL>
  4. Create a feature branch off of the dev branch. git switch -c feature dev
  5. Make sure to have atomic commits and contextual commit messages using Emoji-Log for both the commit messages, and pull request titles.
  6. Keep Pull Requests small in scope (like a single feature per PR) to make approval and refactoring easier.
  7. Push your local feature branch to your remote repository on GitHub git push -u origin feature
  8. 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
  9. Pull Request must pass Linting, Unit Tests, and any other checks for a passing build to be considered ready for manual review and feedback.
  10. 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 to prod

Thank You!


I'll try to be as responsive as possible in reviewing and accepting pull requests. I appreciate your contributions very much!