Skip to content

Latest commit

 

History

History
29 lines (15 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

29 lines (15 loc) · 1.29 KB

Contributing

The following is a set of guidelines for contributing to Rap. Please spend several minutes reading these guidelines before creating an issue or pull request.

Open Development

Rap consists of rap-client, rap-server, rapper. The different work needs to develop on respective repository or some may need all the repositories. Pull requests sent by both internal team members and external contributors will go through the same review process.

New Features

If you want to develop new feature, we recommend that you first create an issue that describes the scenario and usage, see RFC.

Then you can start to develop the feature.

Pull Request

We are monitoring for pull requests. We will review your pull request and either merge it, request changes to it, or close it with an explanation.

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

  1. Create your branch from the master.

  2. If you've added route that should be tested, add tests!

  3. Ensure the test suite passes yarn run test.

Development Workflow

After cloning rap-server, you can follow the development detail in README.md