Skip to content

Commit

Permalink
docs: improved content of development.md and add nunjucks-filters scr… (
Browse files Browse the repository at this point in the history
  • Loading branch information
Adi-204 authored Feb 6, 2025
1 parent 31851c7 commit 219cf35
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
7 changes: 6 additions & 1 deletion Development.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,13 +89,18 @@ To release a major/minor/patch:

### Conventional Commits:

For a detailed explanation of conventional commits, refer to [this guide](CONTRIBUTING.md#conventional-commits)
To maintain a clear git history of commits and easily identify what each commit changed and whether it triggered a release, we use conventional commits. The feat and fix prefixes are particularly important as they are needed to trigger changesets. Using these prefixes ensures that the changes are correctly categorized and the versioning system functions as expected.

For Example:
```
feat: add new feature
```


### Pull Request Title Guidelines:
To ensure successful workflow execution, all PR titles must follow the Conventional Commits format and PR titles should start with a lowercase character. Incorrect PR titles can cause workflow failures, preventing PRs from being merged.
For the PR titles you can refer to [this guide](CONTRIBUTING.md?plain=1#L60)

#### Manual

1. Create a new release markdown file in the `.changeset` directory. The filename should indicate what the change is about.
Expand Down
3 changes: 3 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@
"generator:lint:tpl:validator": "turbo run lint:tpl:validator --filter=@asyncapi/generator",
"generator:update:snapshot": "turbo run test:integration:update --filter=@asyncapi/generator",
"nunjucks-filters:test": "turbo run test --filter=@asyncapi/nunjucks-filters",
"nunjucks-filters:docs": "turbo run docs --filter=@asyncapi/nunjucks-filters",
"nunjucks-filters:lint": "turbo run lint --filter=@asyncapi/nunjucks-filters",
"nunjucks-filters:lint:fix": "turbo run lint:fix --filter=@asyncapi/nunjucks-filters",
"components:test": "turbo run test --filter=@asyncapi/generator-components",
"components:build": "turbo run build --filter=@asyncapi/generator-components",
"components:lint": "turbo run lint --filter=@asyncapi/generator-components",
Expand Down

0 comments on commit 219cf35

Please sign in to comment.