[📑 Docs]: Update README - Add steps to run the site locally for development

[fatima-ola]

Description

In the Readme file, after the requirement section, I think Steps to run the site locally for development should be added for first-timer in the steps listed below:

1. Fork and clone the repository Follow these steps to create a fork of this repository and clone it to your local machine.

2. Navigate to the repo directory If you have just run git clone ... , the next step would be to move into the cloned repo:

cd asyncapi

Code of Conduct

• [X] I agree to follow this project's Code of Conduct

[github-actions[bot]]

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.

[pratik9315]

Good idea! You could even include commit messages practices specific to AsyncAPI in the readme. For eg. chore, fix, docs and their short descriptions. Merging gets blocked if the contributos dont write the correct commits maybe that could be helpful too. What do you think about it @fatima-ola ?!

[fatima-ola]

Good idea! You could even include commit messages practices specific to AsyncAPI in the readme. For eg. chore, fix, docs and their short descriptions. Merging gets blocked if the contributos dont write the correct commits maybe that could be helpful too. What do you think about it @fatima-ola ?!

I think it makes sense, it is a good addition. Though am not familiar with the commit messages practices specific to AsyncAPI. Am surely going to look it up.

[darp99]

Can i contribute on this issue?

[akshatnema]

I think Steps to run the site locally for development should be added for first-timer in the steps listed below:

I think we already have the steps written in the README here. So, we don't need any specific section devoted to specify how the site runs locally in development.

You could even include commit messages practices specific to AsyncAPI in the readme. For eg. chore, fix, docs and their short descriptions.

I didn't come up with any such error in commit messages till now. All we need is to make the title of PR starting from chore, fix, feat or docs in order to specify whether this PR needs a specific release or it is just an improvement in the present release. May be you are talking of the title of the PR made.

[pratik9315]

I think we already have the steps written in the README here. So, we don't need any specific section devoted to specify how the site runs locally in development.

Hey @akshatnema ! I think what @fatima-ola meant was to have steps regarding setting up the website repository on our local machine such as git clone, cd website, git remote add upstream etc. The current readme does not mention those steps!

I didn't come up with any such error in commit messages till now. All we need is to make the title of PR starting from chore, fix, feat or docs in order to specify whether this PR needs a specific release or it is just an improvement in the present release. May be you are talking of the title of the PR made.

Oops! You are right! I meant the PR title conventional commits, I worded that wrongly ! Now that I think about it, Since the issue is related setting up the project on our local machine, we can skip writing the PR title practices in the readme for now !?

[akshatnema]

Hey @akshatnema ! I think what @fatima-ola meant was to have steps regarding setting up the website repository on our local machine such as git clone, cd website, git remote add upstream etc. The current readme does not mention those steps!

I'm not sure that these steps are necessary to be added to the README, since none of the AsyncAPI repositories have these instructions written in the README. If any of the maintainers approve, go with it.

[derberg]

we do not need to be consistent across all the repos, especially in case of website where we have a lot of documentation-related contributions. It is ok to have more detailed instructions for people that do not work with git on daily basis

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue 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 issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue 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 issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

[BhaswatiRoy]

Hello Maybe we can add the steps like this for the local setup of the website repo. I can work on this