Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
1 task done
DhairyaMajmudar opened this issue Oct 22, 2024 · 3 comments
Open
1 task done

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

DhairyaMajmudar opened this issue Oct 22, 2024 · 3 comments

Comments

@DhairyaMajmudar
Copy link
Contributor

DhairyaMajmudar commented Oct 22, 2024

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

  • I agree to follow this project's Code of Conduct
Copy link
Contributor

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
Copy link
Member

derberg commented Nov 4, 2024

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
Copy link

hkv24 commented Nov 19, 2024

@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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants