docs: added docs for version control for the style guide #771
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide 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.
soma2000-lang
changed the title
| 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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Dont review it now.Its not ready yet .That s why made it draft
|
This pull request has been automatically marked as stale because it has not had recent activity 😴 It will be closed in 120 days if no further activity occurs. To unstale this pull request, add a comment with detailed explanation. There can be many reasons why some specific pull request has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model. Let us figure out together how to push this pull request forward. Connect with us through one of many communication channels we established here. Thank you for your patience ❤️ |
Description
I created docs for the version control Community/Styleguide content bucket in the community repo.
Related issue(s)
Reference to asyncapi/website#1258