Skip to content

Latest commit

 

History

History
42 lines (32 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

42 lines (32 loc) · 1.77 KB
Raw

Contributing

First, thanks for being willing to contribute!

Project Setup

  1. For and clone this repo
  2. Run yarn install to install all dependencies (we require yarn instead of any other JS package manager)
  3. Create a branch for your PR with git checkout -b your-branch-name

ℹ️ Credit: From React Testing Library
Tip: Keep your main branch pointing at the original repository and make pull requests from branches on your fork. To do this, run:

git remote add upstream https://github.com/BeameryHQ/ddd-ts.git
git fetch upstream
git branch --set-upstream-to=upstream/main main

This will add the original repository as a "remote" called "upstream", then fetch the git information from that remote and set your local main branch to use the upstream main branch whenever you run git pull. You can now make all of your pull request branches based on this main branch. Whenever you want to update your version of main, do a regular git pull.

Standards

  • Commit messages follow the Conventional Commit spec;
  • Code styling is enforced via ESLint and Prettier. To check your contribution, run yarn lint;
  • Tests are run using Jest, via yarn test. We do not currently enforce code coverage but new changes should not cause regressions. Make sure and update tests if they break;

Our CI setup, using Github Actions, will also check these standards before contributions can be merged.

Help needed

Please checkout the the open issues.