Skip to content

Latest commit

 

History

History
45 lines (27 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

45 lines (27 loc) · 1.6 KB

Contributing to SynTest

First off all, thank you for taking the time to contribute to this project!

This document outlines a set of guidelines for contributing to the SynTest Framework, which is hosted in the SynTest Framework Organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table Of Contents

Code of Conduct

How Can I Contribute?

Code of Conduct

This project and everyone participating in it is governed by the SynTest Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

You can help this project by submitting report of bugs you have encountered or by suggesting improvements or new features that you would like to see in the framework.

Your First Code Contribution

If you don't know where to begin? You can start by looking through issues with the tags beginner and help-wanted.

  • beginner: Issues which should only require a few lines of code, and a test or two.
  • help-wanted: Issues which should be a bit more involved than beginner issues.

To start

After cloning the project first install the dependencies. This will also automatically setup pre-commit hooks using husky. These hooks will enforce code linting and formatting. Finally, it will install the dependencies of the sub-projects.

npm install

Now you can create a new branch with the following format:

[issue number]-short-description

Happy coding!