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

Latest commit

 

History

History
36 lines (24 loc) · 1.81 KB

contributing.md

File metadata and controls

36 lines (24 loc) · 1.81 KB
Raw

Contributing!

First off, thanks for taking the time to contribute! <3

All types of contributions are encouraged and welcome. 💜 Though please make sure to read through the following guidelines before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. Besides the creation and maintenance of ports we appreciate all sorts of code and non-code contributions. These include but are not limited to:

  • Typo fixes
  • Documentation improvements
  • Pull request reviews
  • Feature requests
  • Opinions & suggestions

 

✔️ Guidelines

The following is a set of guidelines for contributing to this project. Use your best judgment, and feel free to propose changes to this document in a pull request.

  • PRs should go to the dev branch. Reasons:
    • If there is already stuff under development, then it's likely that a conflict may occur.
    • Documentation tends not to be updated by PRs.
    • Testing.
  • Use the .editorconfig file (located at the root of this project) on your editor so as to "maintain consistent coding styles". For instructions on how to use this file refer to EditorConfig's website.

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

 

💡 Recommendations

  • Create a topic branch on your fork for your specific PR.
  • If it's your first time contributing to a project then read About pull requests on Github's docs.