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: add version control section to AsyncAPI Style Guide #1741

Closed
wants to merge 1 commit into from

Conversation

Recxsmacx
Copy link

Fixes #1699

Add a new file version-control.md to the AsyncAPI Style Guide.

  • Create the directory asyncapi.com/docs/community/styleguide/.
  • Add a new file version-control.md in the directory asyncapi.com/docs/community/styleguide/.
  • Include guidelines on the importance of version control in documentation, using Git for version control, branching strategy, commit messages, pull requests, and documentation updates.
  • Provide examples of version control practices, including creating a feature branch, writing a commit message, creating a pull request, and tagging a release.

Fixes #1699

Add a new file `version-control.md` to the AsyncAPI Style Guide.

* Create the directory `asyncapi.com/docs/community/styleguide/`.
* Add a new file `version-control.md` in the directory `asyncapi.com/docs/community/styleguide/`.
* Include guidelines on the importance of version control in documentation, using Git for version control, branching strategy, commit messages, pull requests, and documentation updates.
* Provide examples of version control practices, including creating a feature branch, writing a commit message, creating a pull request, and tagging a release.
@Recxsmacx Recxsmacx changed the title add version control section to AsyncAPI Style Guide docs: add version control section to AsyncAPI Style Guide Feb 20, 2025
@Recxsmacx
Copy link
Author

@derberg please review this one too

@Recxsmacx Recxsmacx closed this Feb 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[📑 Docs]: new style guide - Version Control
1 participant