Skip to content
This repository has been archived by the owner on Jun 24, 2022. It is now read-only.

Latest commit

 

History

History
65 lines (41 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

65 lines (41 loc) · 2.76 KB

Adapted from react-native-testing-library for WHS.js

Contributing

Code of Conduct

We want this community to be friendly and respectful to each other. Please read the full text so that you can understand what actions will and will not be tolerated.

Our Development Process

The core team works directly on GitHub and all work is public.

Development workflow

Working on your first pull request? You can learn how from this free series: How to Contribute to an Open Source Project on GitHub.

  1. Fork the repo and create your branch from master (a guide on how to fork a repository).
  2. Run yarn to setup the developement environment.
  3. Do the changes you want and test them out in the example app before sending a pull request.

Commit message convention

We prefix our commit messages with one of the following to signify the kind of change:

  • fix: bug fixes, e.g. fix incorrect error message.
  • feat: new features, e.g. add useful API.
  • refactor: code/structure refactor, e.g. new folder structure.
  • docs: changes into documentation, e.g. add usage example for getByText.
  • test: adding or updating tests, eg unit, snapshot testing.
  • chore: tooling changes, e.g. change circle ci config.
  • BREAKING: for changes that break existing usage, e.g. change API.

Our pre-commit hooks verify that your commit message matches this format when committing.

Linting and tests

We use typescript for type checking, tslint for linting and formatting the code, and jest for testing. Our pre-commit hooks verify that the linter and tests pass when commiting. You can also run the following commands manually:

  • yarn typecheck: run typescript on all files.
  • yarn lint: run tslint.
  • yarn test: run tests.

Sending a pull request

When you're sending a pull request:

  • Prefer small pull requests focused on one change.
  • Verify that typescript, tslint and all tests are passing.
  • Preview the documentation to make sure it looks good.
  • Follow the pull request template when opening a pull request.

Publishing a release

We use github actions to release the latest code to the respective branch [master] => staging and [stable] => stable. To publish a release, push a commit to one of the previous branches.

Reporting issues

You can report issues on our bug tracker. Please follow the issue template when opening an issue.

License

By contributing to whs.js, you agree that your contributions will be licensed under its GPL v3 license.