Table Of Contents
About The Project
(examples)
For more examples, please refer to the Documentation
Roadmap
See the open issues for a list of proposed features (and known issues).
Contributing
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 to discuss it, or directly create 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 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
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.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes w/ Descriptive Message (
git commit -m 'Added AmazingFeature...'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a New Pull Request
See CONTRIBUTING.md for our Contribution Guidelines and more info.
License
Distributed under the MIT License.
Distributed under the MIT License. See LICENSE.txt for more information.See LICENSE.txt for more information.
Authors
- Zander - (ZandercraftGames) - Project Developer