generator icon indicating copy to clipboard operation
generator copied to clipboard

[Docs]: Potential improvements in `development.md` file

Open DhairyaMajmudar opened this issue 1 year ago • 1 comments

Describe the bug you found in AsyncAPI Docs.

Below is the list of potential improvements that can be made in Development.md :=

  1. Missing scripts for nunjucks-filter package in root package.json file
  2. Missing scripts to run nunjucks-filter package tests.
  3. The conventional commits section can be enhanced more by providing the links to conventional commits docs (https://www.conventionalcommits.org/en/v1.0.0/) and adding some more examples like fix, ref, etc...
  4. There should be a section in docs guiding contributors to title the PR title correctly so that the workflows related to them don't fail. conventionalcommits.org

Attach any resources that can help us understand the issue.

N/A

Code of Conduct

  • [X] I agree to follow this project's Code of Conduct

DhairyaMajmudar avatar Oct 22 '24 19:10 DhairyaMajmudar