Skip to content

Latest commit

 

History

History
65 lines (40 loc) · 2.1 KB

CONTRIBUTING.md

File metadata and controls

65 lines (40 loc) · 2.1 KB
Raw

Contribution guide

We love pull requests from everyone. By participating in this project, you agree to abide by the [code of conduct].

How to Contribute

Fork, then clone the repo:

git clone git@github.com:your-username/unique-names-generator.git

Set up your machine:

npm install

Make sure the tests pass:

npm test

Make your change. Add tests for your change. Make the tests pass:

npm test

Semantic Versioning

We follow semantic versioning. We release patch versions for bugfixes, minor versions for new features, 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 the release notes.

Style Guide

We use an automatic code formatter called Prettier. Run npm run format after making any changes to the code.

Then, our linter will catch most issues that may exist in your code. You can check the status of your code styling by simply running npm run lint.

Sending a Pull Request

Please consider these guidelines when filing a pull request:

  • Commits follow the Angular commit convention
  • Typescript code follows the rules set in the .prettierrc file. Run npm run format to automatically format all the documents with Prettier.
  • Features and bug fixes should be covered by test cases

Push to your fork and submit a pull request.

At this point you're waiting on us. We may suggest some changes or improvements or alternatives.

Some things that will increase the chance that your pull request is accepted: