Thank you, thank you so much 🙏 for your interest in contributing to this repository!
This is a container of @nrwl/nx plugins I decided or needed to write.
At the time of writing, the only available plugin is nx-plugin-openapi.
You can contribute new features, add or update docs, fix or submit new issues, share feedback, basically anything you feel like contributing.
Well, go on and open a pull request!
But for me to feel comfortable accepting your code in my codebase, you'll need some tools:
- Some way of beautifying your code with Prettier, using the configuration file provided in this repository
- An IDE / code editor with an active EditorConfig extension, using the configuration file provided in this repository
- Commitizen for your commit messages
- NVM, so that you can run
nvm usefrom the workspace root and be sure we are using the same Node version
Then, do your thing and make sure you code doesn't break any test.
# Unit tests
nx affected:test --base=main
# E2e tests
nx affected:e2e --base=mainSpeaking of which, if you are contributing to nx-plugin-openapi, you can test it by following the official guide.
The gist of the thing is you first run:
nx e2e nx-plugin-openapi-e2eAnd this will run the test suite but it will also create a working Nx workspace in tmp/nx-e2e/proj where you can run commands and fiddle with things.
Also please add new test cases if you are adding new features, or a test case specific for the bug you are fixing so that we can be reasonably safe against regressions.