Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

53 lines (33 loc) · 2.79 KB

Contributing

The following is a set of guidelines for contributing to Ciklum digital organisation packages. Please spend several minutes in reading these guidelines before you create an issue or pull request.

Code of Conduct

We have adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Open Development

All work happens directly on GitHub. Both core team members and external contributors send pull requests which go through the same review process.

Branch Organization

There are three types of branch we maintain: master issue/* feat/*.

  • If you send a Fix Request, please do it in: issue/short-issue-title
  • If you send a Feature Request, please do it in: feat/short-feature-title

Reporting bugs and questions

We are using GitHub Issues for bug tracing. Please, use template for issue/feature creating.

Before you reporting a bug, please make sure you've searched exists issues.

Sending a Pull Request

The core team is monitoring for pull requests. We will review your pull request and either merge it, request changes to it, or close it with an explanation.

Before submitting a pull request, please make sure the following is done:

  1. Before you reporting a bug, please make sure you've searched exists issues.
  2. Open a new issue in the issues tracker
  3. Fork the repository and create your branch from proper branch.
  4. Run yarn install in the repository root.
  5. If you've fixed a bug or added code that should be tested, add tests!
  6. Ensure the test suite passes (yarn test). Tip: yarn test -- --watch TestName is helpful in development.
  7. Ensure the code lints passes. Run yarn lint for check it.
  8. We are using commitizen and commit lint. Use yarn commit for prompting commit message window.
  9. Submit a pull request, referencing any issues it addresses.
  10. For PR creation use template

Development Workflow

After cloning proper module, run yarn to fetch its dependencies. Then, you can run several commands:

  1. yarn lint checks the code style and yarn lint:fix for fixing linting errors
  2. yarn test runs the complete test suite.
  3. yarn build compiles TypeScript code to the dist directory.

License

By contributing your code to the ciklum-digital GitHub org repositories, you agree to license your contribution under the MIT license.