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: added docs for version control for the style guide #771

Closed
wants to merge 2 commits into from
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/community/style-guide/version-control.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: Version Control
weight: 60
---

Version control is a critical tool for managing the evolution of AsyncAPI documents. It allows teams to track changes to the documentation over time, revert to previous versions, and collaborate on changes.

There are a number of different version control systems that can be used for AsyncAPI, but the most popular are Git and Mercurial. These systems allow you to create a central repository for your documentation, and then track changes to the files in that repository.

When you make a change to an AsyncAPI document, you can create a new commit that records the changes you made. This commit will include a message that describes the changes, and it will also include a unique identifier that allows you to track the commit over time.

If you ever need to revert to a previous version of the documentation, you can simply checkout that version from the repository. This will restore the documentation to the state it was in at that point in time.

Version control is also a valuable tool for collaboration. If you're working on an AsyncAPI document with other people, you can share the repository with them and they can make changes to the documentation as well. This allows you to work together on the documentation and ensure that everyone is on the same page.

In addition to tracking changes to the documentation, version control can also be used to identify when key decisions were made along the way. By looking at the commit messages, you can see who made the decision, when it was made, and why it was made. This can be helpful for understanding the evolution of the documentation and for making decisions about future changes.

Here are some best practices for using version control for AsyncAPI documents:

Use a descriptive commit message. The commit message should clearly explain the changes that were made to the documentation.
Make each commit a logical unit. Each commit should represent a single change to the documentation.
Avoid indiscriminate commits. Don't commit changes that are not related to each other.
Incorporate others' changes frequently. If you're working on a document with other people, incorporate their changes frequently so that everyone is working on the latest version of the documentation.
Share your changes frequently. Share your changes with others so that they can review them and provide feedback.
Coordinate with your co-workers. Make sure that you're coordinating with your co-workers so that you're not making changes that conflict with their changes.
Version control is a powerful tool that can help you to manage the evolution of AsyncAPI documents. By following these best practices, you can ensure that your documentation is well-organized and easy to track.
Comment on lines +20 to +26
Copy link
Contributor

@AnimeshKumar923 AnimeshKumar923 Jul 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @soma2000-lang, some suggestions from my side on this section:

  • You should leave a gap between each separate point and its following description.
  • You can make each point either in a bulleted list or numbering list.
  • The description should be indented for each point.

I don't know how to do the indenting and stuff so suggesting these points.
@alequetzalli please have a look at this and provide your valuable feedback.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dont review it now.Its not ready yet .That s why made it draft

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay. Got it. 👍