Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
84 lines (64 loc) · 3.11 KB

CONTRIBUTING.md

File metadata and controls

84 lines (64 loc) · 3.11 KB

Contributing

We are open and grateful for any contributions made by you!

Reporting Issues

Before opening an issue, please make sure that your issue hasn't been already reported by using the search functionality of the issue tracker.

Development

Visit the issue tracker to find a list of open issues that are easy to pick up or need some love.

Fork, then clone the repo:

git clone https://github.com/your-username/create-react-microservice.git
cd create-react-microservice
yarn install
yarn run bootstrap

Building

Running the build task will re-build the CLI.

yarn run build

Testing, Type-Checking with Flow and Linting

To run the tests:

yarn run test

To continuously watch and run the unit-tests, execute the following:

yarn run jest:watch

To perform linting with eslint, run the following:

yarn run lint

To perform a single check of the types with flow, run the following:

yarn run flow

Development in the scaffold

In case you would like to contribute to the scaffold, we recommend you to change into packages/create-react-microservice-scaffold/src and run the following commands to bootstrap it.

yarn install
yarn run bootstrap

New Features

Please open an issue with a proposal for a new feature or refactoring before starting on the work. We don't want you to waste your efforts on a pull request that we won't want to accept.

Commit guidelines and semantic release

Our repositories make great use of semantic-release. This tool automatically creates releases once the code is pushed to our master branch and the commits signal a release-worthy CI run.

All commits must contain a prefix of one of the following values, e.g.

Prefix Description Release type
!!! Breaking change Major
FEATURE Feature Minor
BUGFIX Bugfix Patch
SECURITY Security change Patch
TASK Other changes No release

So in case you want to submit a bugfix, you should execute git commit -m "BUGFIX: A short description of what this commit solves - solves #21" where 21 is the issue number of the bug you fix.

Submitting Changes

  • Open a new issue in the issue tracker.
  • Fork the repo.
  • Create a new feature branch based off the master branch.
  • Make sure all tests pass and there are no linting errors.
  • Make sure to commit your changes with the guidelines written above.
  • Submit a pull request, referencing any issues it addresses.

Please try to keep your pull request focused in scope and avoid including unrelated commits.

After you have submitted your pull request, we'll try to get back to you as soon as possible. We may suggest some changes or improvements.

Thank you for contributing! :-) ❤️