Skip to content

Latest commit

 

History

History
36 lines (22 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

36 lines (22 loc) · 1.1 KB

Contributing to Neulabs CDK Constructs

Code of Conduct

Please read the full text so that you can understand what actions will and will not be tolerated.

Issues

We have two type of issue:

  1. Bug report
  2. Feature reqeust
  3. Question

Development

Online one-click setup for contributing

Requirements:

  • Node >= v20.12.0
  • Yarn >= 1.22

Setup env:

  • yarn install
  • npx projen default
  • cd docs yarn install

Pull Requests

  1. This project uses >= node@16.x and npm@9.x for development
  2. Before opening a Pull Request, please find the existing related issue or open a new one to discuss the proposed changes. A PR without a related issue or discussion has a high risk of being rejected. We are very appreciative and thankful for your time and efforts, and we want to make sure they are not wasted.
  3. After your proposal has been reviewed and accepted by at least one of the project's maintainers, you can submit a pull request.
  4. When opening a PR, make sure to follow the checklist inside the pull request template.