Skip to content

Latest commit

 

History

History
103 lines (57 loc) · 6.25 KB

CONTRIBUTING.md

File metadata and controls

103 lines (57 loc) · 6.25 KB
Raw

How to contribute

Reviewpad is an open source project to empower teams to automate their development process - issues and pull requests. We believe that teams should be able to contribute to a project the the most fast and efficient way. We are very excited to see your interest on how to help us make Reviewpad the best automation tool.

Code of Conduct

Reviewpad projects have a Code of Conduct to which all contributors must adhere. Please read it before interacting with the repository or the community in any way.

Open Development

All work on Reviewpad happens directly on GitHub. Both core team members and external contributors send pull requests which go through the same review process.

Semantic Versioning

Reviewpad follows semantic versioning. We release patch versions for critical bugfixes, minor versions for new features or non-essential changes, and major versions for any breaking changes. When we make breaking changes, we also introduce deprecation warnings in a minor version so that our users learn about the upcoming changes and migrate their code in advance.

Every significant change is documented in each release.

Branch Organization

Submit all changes directly to the main branch. We don't use separate branches for development or for upcoming releases. We do our best to keep main in good shape, with all tests passing.

Bugs

Where to Find Known Issues

We are using GitHub Issues for our bugs. We keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn't already exist.

Reporting New Issues

The best way to get your bug fixed is fill our bug report template. Please follow the instructions in the template and provide as much information as possible. The more information you provide, the more likely someone will be successful reproducing the issue and finding a fix.

How to Get in Touch

Please note that the Reviewpad Discord is the same used by the team. So you'll be talking directly with the team 💪

Proposing a Change

If you intend to change a piece of Reviewpad that is not yet being addressed on any issue we first invite you to fill an issue. This lets us reach an agreement on your proposal before you put significant effort into it.

If you're only fixing a bug, it's fine to submit a pull request right away but we still recommend to file an issue detailing what you're fixing. This is helpful in case we don't accept that specific fix but want to keep track of the issue.

Your First Pull Request

Working on your first Pull Request? You can learn how from this free video series:

How to contribute to open source within 10 minutes - start now! by our friend Eddie Jaoude

To help you get your feet wet and get you familiar with our contribution process, we have a list of good first issues that contain bugs that have a relatively limited scope. This is a great place to get started.

If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don't accidentally duplicate your effort.

Sending a Pull Request

Reviewpad is monitoring all pull requests and notifying the team. We will review your pull request and either merge it, request changes to it, or close it with an explanation. We'll do our best to provide updates and feedback throughout the process.

Before submitting a pull request, please make sure the following is done:

  1. Fork the repository and create your branch from main.
  2. Run yarn in the repository root.
  3. If you've fixed a bug or added code that should be tested, add tests!
  4. Ensure the project builds (yarn build).
  5. If you need a debugger please run yarn start and open http://localhost:3000 in your browser.

Contribution Prerequisites

  • You have Node installed at LTS and Yarn at v1.2.0+.
  • You have gcc installed or are comfortable installing a compiler if needed. Some of our dependencies may require a compilation step. On OS X, the Xcode Command Line Tools will cover this. On Ubuntu, apt-get install build-essential will install the required packages. Similar commands should work on other Linux distros. Windows will require some additional steps, see the node-gyp installation instructions for details.
  • You are familiar with Git.

Development Workflow

After cloning Reviewpad, run yarn to fetch its dependencies. Then, you can run several commands:

  • yarn build creates a build folder with all the packages.
  • yarn start starts the development server on http://localhost:3000

Commit convention

As commit convention, we adopt Conventional Commits.

This is not the case for all the commits in the history but any new commit should follow it.

If you want to enforce it as a pre-hook commit you can use tiger.

License

By contributing to Reviewpad, you agree that your contributions will be licensed under its LGPL-3.0 license.

Attribution

This documentation is based on reactjs.org contributing guidelines.