Add Documentation

This commit is contained in:
SowinskiBraeden committed 2023-10-20 17:37:41 -07:00
1 parent 970fd93cf4
commit a285aee5ba
4 files changed
+99 -1

No files matched your search

+19
View File
@@ -0,0 +1,19 @@
<!-- CONTRIBUTING -->
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Clone the Project
2. Create your Feature Branch (`git checkout -b update/AmazingFeature`)
3. Commit your Changes (`git commit -m 'update/your-update'`) please use the following for your commits:
i. `update/your-update`
ii. `fix/your-fix`
iii. `refactor/your-refactor` (Refactoring code, doesn't change behavior)
iv. `change/your-change` (Changing existing code behavior)
4. Push to the Branch (`git push origin update/AmazingFeature`)
5. Open a Pull Request
Do keep in mind of the [package.json](/package.json) version. Version structure is as follows: `(major).(minor).(patch)`