Skip to content

Latest commit

 

History

History
60 lines (35 loc) · 3.38 KB

CONTRIBUTING.md

File metadata and controls

60 lines (35 loc) · 3.38 KB
Raw

Introduction

Greetings, contributor

Thank you for considering contributing to Remote Retro. We're happy to have you!

Types of contributions we're looking for

The best way to contribute is to take a look at our current backlog and work on a story that you're most excited about. Please take a look at the Project Management section of our Readme for viewing the backlog. Bug fixes and documentation improvements are also welcome.

Code of Conduct

Please read our Code of Conduct before contributing.

First time contributing?

Unsure where to begin contributing to Remote Retro? You can start by looking through issues that have the "beginner-friendly" or "help wanted" label.

Getting started

  • Before you start coding, please see the Dev Environment Setup and Tests sections of the Readme for information about getting set up and running the tests.
  • We require all contributors to sign a Contributor License Agreement before contributing. You will be prompted to electronically sign the individual CLA when you make a pull request.
    • The individual CLA can be viewed here
    • The corporate CLA can be viewed here
  • Please see the Project Management section to see how to view Remote Retro's current feature pipeline.

Once you're ready to start coding:

  1. Create your own fork of the code
  2. Make the necessary changes in your fork
  3. If you like the change and think the project could use it:
    • Be sure you have followed the code style for the project.
    • Make a pull request, and be sure to fill out the information in the template.

How to report a bug

Security issues

If you find a security vulnerability, do NOT open an issue. Email [email protected] instead.

In order to determine whether you are dealing with a security issue, ask yourself these two questions:

  • Can I access something that's not mine, or something I shouldn't have access to?
  • Can I disable something for other people?

For non-security issues

Please open an issue and use the template provided. Please add the "Bug" label.

How to suggest a feature or enhancement

Before suggesting a feature, please read through the Roadmap to MVP and check the backlog to make sure that the story doesn't exist already. Once you're ready to suggest the feature or enhancement, open an issue and use the provided template. Please also add the "feature request" label.

Code review process

After you submit your pull request, it will be reviewed within 10 business days and we will give you feedback on any needed changes. After feedback has been given we expect responses within two weeks. After two weeks we may close the pull request if it isn't showing any activity.

Code Style

ESLint is used for checking JavaScript code style. It is also useful for avoiding some errors. Please use indentation of 2 spaces, and no semicolons. Please use ES2015 (ES6).