nayaabkhan/react-polyglot

View on GitHub
CONTRIBUTING.md

Summary

Maintainability
Test Coverage
# Contributing Guide

Thank you for considering to contribute. If you're looking for a way to get contributing, the best way is to look for a [Good first issue](https://github.com/nayaabkhan/react-polyglot/labels/good%20first%20issue).

## Setting up the project

1. Fork and clone the repo
2. `yarn`
3. `yarn test`
4. Use a branch for your PR: `git checkout -b your-branch-name`

## Commiting

Please consider reading this [excellent guide](https://chris.beams.io/posts/git-commit/) for writing good commit messages. This is a convention that we aim to follow for this project.

- Please keep unrelated changes in separate commits.
- Keep related changes in the same commit.

## Before submitting a PR

1. Make sure that all tests pass.
2. Make sure you've updated type definitions, if required.
3. Make sure there are no breaking changes.