search

asyncapi / generator

Use your AsyncAPI definition to generate literally anything. Markdown documentation, Node.js code, HTML documentation, anything!
https://asyncapi.com/docs/tools/generator
Apache License 2.0
770 stars 233 forks source link

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

Open DhairyaMajmudar opened 1 month ago

DhairyaMajmudar commented 1 month ago

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.

Attach any resources that can help us understand the issue.

N/A

Code of Conduct

github-actions[bot] commented 1 month ago

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

derberg commented 3 weeks ago

sounds good to me

probably better if dev guide first instructs to run npm run test to run test for all apps by default?

hkv24 commented 6 days ago

@DhairyaMajmudar can you elaborate on exactly what scripts are missing for nunjucks-filter in root package.json? I would assume that you are talking about the unit tests and integration tests and also a build command maybe?