Skip to content

Latest commit

 

History

History
64 lines (40 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

64 lines (40 loc) · 2.27 KB

Contributing to AutolabCLI

🎉 First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to AutolabCLI and its packages, which are hosted in the AutolabJS Organization on GitHub. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table Of Contents

What should I know before I get started?

How Can I Contribute?

Styleguides

What should I know before I get started?

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code.

Frameworks

This project uses NodeJS as the primary base. Hence a familiarily with Javascript would be good.

How Can I Contribute?

Reporting Bugs

Fill out the required template, the information it asks for helps us resolve issues faster.

Suggesting Enhancements

Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.

Your First Code Contribution

Unsure where to begin contributing to AutolabCLI? You can start by looking through these Level: Beginner issues:

  • [Beginner issues][Level: Beginner] - issues which should only require a few lines of code, and a test or two.
  • Installation Steps

Pull Requests

  • Fill in the required template
  • Include screenshots and animated GIFs in your pull request whenever possible.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally
  • The title should be of the format <issue> Title