Cleanup the README a bit

This commit is contained in:
2023-09-27 03:16:58 -04:00
parent c8822029fe
commit 9dc5bea60c
2 changed files with 26 additions and 0 deletions

26
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,26 @@
# Contribution Guidelines
Contributions are what make the open source community such an amazing place to be, learn, inspire, and create. Any
contributions you make are **greatly appreciated**. Our goal as a project is to be open to feedback and contributions,
fostering an active community in which you can truly be involved in improving TechnicFlux and keeping it bug-free.
* If you have suggestions for adding or removing features, feel free to [open an issue](https://github.com/Zandercraft/TechnicFlux/issues/new)
to discuss it, or directly [create a pull request](#creating-a-pull-request).
* Please make sure you check your spelling and grammar.
* Make sure your changes comply with StandardJS code style by running `standard --fix` and fixing any issues.
* Ensure that you update the README.md to match any changes your PR includes.
* Ensure that you update the latest Unreleased entry in [CHANGELOG.md](./CHANGELOG.md) with your changes.
* Create individual PRs for each suggestion, bug-fix, or enhancement.
* Use new branches on your fork to separate different changes _(see [Creating A Pull Request](#creating-a-pull-request))_.
### Creating A Pull Request
> When naming your forks, please prefix your fork names with the type of change they include:
> **Bug Fixes** - `bugfix/`
> **New Features** - `feature/`
> **Removed Features** - `removal/`
> **Deprecations** - `deprecation/`
> **Project-Related Changes** - `project/` _includes grammar, document changes, GitHub actions, etc._
> _This makes it much easier to distinguish the purpose of a branch by its name._
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes w/ Descriptive Message (`git commit -m 'Added AmazingFeature...'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a New Pull Request

BIN
README.md

Binary file not shown.