Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 2.41 KB

CONTRIBUTING.md

File metadata and controls

37 lines (23 loc) · 2.41 KB

Contributing Guide

Thanks for getting involved 🎉

We love to see new contributors, and we strive to provide a welcoming and inclusive environment. We ask that all contributors read and follow this guide so that we can be of more help.

Questions and help

If you have an idea or question about something you think we can do to improve this application. Feel free to create a feature request and add your thoughts.

Or, if you found something not working when trying our application. Report an issue to help us improve the quality.

Issues and Bugs

If you find a bug in the source code or a mistake in the documentation, you can help us by submitting a ticket to our GitHub issues. Even better, you can submit a Pull Request to our Typing in the dark project.

Feature Requests

You can request a new feature by submitting a ticket to our GitHub issues. If you would like to implement a new feature then consider what kind of change it is:

  • Major Changes that you wish to contribute to the project should be discussed first. Please open a ticket which clearly states that it is a feature request in the title and explain clearly what you want to achieve in the description, and we will discuss with you what should be done in that ticket. You can then start working on a Pull Request.
  • Small Changes can be proposed without any discussion. Open up a ticket which clearly states that it is a feature request in the title. Explain your change in the description, and you can propose a Pull Request straight away.

Coding Rules

To ensure consistency throughout the source code, keep these rules in mind as you are working: