Thank you for being interested in helping with Practical CDK Constructs!
- Look at the "Issues" and choose something to implement
- Fork this project to your account
- Implement it, create unit tests and run
make rules-doc
to update documentation - Create a PR after you complete it to master branch
- Use make targets for common tasks (they are the same that are run during pipelines)
make build
make lint
make test
make rules-doc
- Discuss design or implementation details of a specific feature in the related Issue comments
- If you have more generic question, create a new Issue
-
If you find any bug, create a new Issue describing what is the structure of your monorepo and what kind of error you had. If possible, send a link of your repo, or a screenshot of its structure.
-
If you want a new feature, open an Issue and explain your real use case, the kind of problems you have nowadays and how you think Monolint could help you in practice.
- Create the new rule under folder 'rules'
- Create unit tests for it based on test monorepo at 'rules/test-monorepo'
- Register the new rule in file 'rules/registry.ts'
- Add the rule as default in 'src/defaultConfig.ts' if it is a generic enough rule
- Install npm and "make" on your machine
- Git clone this repo
- Type
make run
to see a first run with success and errors examples - Use preferrebly VSCode with ESLint plugin installed so linting with auto fix will be available
- Everytime a PR or a commit is made to "master" branch linting and building will be run. Your PR will only be analysed with a successfull GH pipeline run
- When a new tag is created a GH pipeline will publish a release to NPM registry