Skip to content

Latest commit

 

History

History
78 lines (61 loc) · 4.06 KB

CONTRIBUTING.md

File metadata and controls

78 lines (61 loc) · 4.06 KB
Raw

Contribution Guidelines

Thank you so much taking the time to contribute! ❤️

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 like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation:

  • ⭐ Star the project
  • 💬 Tweet about/share it
  • 📜 Refer to TechnicFlux in your own project/modpack's description
  • 🗣️ Tell your friends about TechnicFlux

Table of Contents

Code of Conduct

This project and everyone participating in it are governed by the TechnicFlux Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

I Have a Question

If you want to ask a question, we assume that you have read all available Documentation.

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Open an Issue.
  • Provide as much context as you can about your issue.
  • Make sure to fill out all required fields in the template.

We will then take care of the issue as soon as possible.

I Want To Contribute

Legal Notice

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.

⚠️ Security Issues

You must never report security-related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead, see SECURITY.md for instructions on reporting this type of issue.

  • 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.

Creating A Pull Request

  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

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.