Skip to content

Latest commit

 

History

History
40 lines (24 loc) · 1.66 KB

CONTRIBUTING.md

File metadata and controls

40 lines (24 loc) · 1.66 KB

Contributing Guidelines

Thanks for taking the time to contribute!

The following is a set of guidelines for contributing to Cosmic Typer. These are just guidelines, not rules, so use your best judgement and feel free to propose changes to this document in a pull request.

Getting Started

Typer is a tool built with vanilla JavaScript and Gulp. Though it's not 100% important to understand Gulp, as the build process is pretty complete at the moment, you can head over to Gulp and take a look at the documentation.

Community

  • If you have any questions regarding Typer, open an issue.

Issue

Ensure the bug was not already reported by searching on GitHub under issues. If you're unable to find an open issue addressing the bug, open a new issue.

Please pay attention to the following points while opening an issue.

Write detailed information

Detailed information is very helpful to understand an issue.

For example:

  • How to reproduce the issue, step-by-step.
  • The expected behavior (or what is wrong).
  • Error message and line number.
  • The browser make and version.

Pull Requests

Pull Requests are always welcome.

  1. When you edit the code, please run npm run lint to check the formatting of your code before you git commit. ( COMING SOON )
  2. Ensure the PR description clearly describes the problem and solution. It should include:
    • The browser amke and version on which you tested.
    • The Typer version on which you tested.
    • The relevant issue number, if applicable.