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

Enhancement: Contributing.md guidelines #4640

Open
0xJaskeerat opened this issue Sep 22, 2023 · 3 comments
Open

Enhancement: Contributing.md guidelines #4640

0xJaskeerat opened this issue Sep 22, 2023 · 3 comments

Comments

@0xJaskeerat
Copy link

Is your enhancement request related to a problem? Please describe.
I was setting up the erxes project and stumbled upon this page Link

Under the heading : Issues before PRs
The 2. point says
When you are ready to start working on a change, you should first fork the erxes repo and branch out from the develop branch.

Problem :

Any newbie who's just getting started with forking , leme tell what he'll encounter
  • He'll fork the repo , the default branch is master
  • After forking , his own version only has the master branch now , so how he's gonna make a new branch from the develop which is not present. In a hurry he may create a branch from the master only

Describe the solution you'd like
We can modify the description to something like this :

  • When you are ready to start working on a change, you should first fork the erxes repo
  • Clone the repository in you local with URL of your forked version
  git clone https://github.com/yourusername/erxes.git
  • Add the Original Repository as a Remote:
  git remote add upstream https://github.com/erxes/erxes.git
  • Fetch the "develop" Branch:
  git fetch upstream
  • Create your Local branch from the "develop" Branch:
  git checkout -b develop upstream/my_develop_branch

After these steps the 3. and 4. point make sense 💪🏻

Additional context
Please leme know if you find these changes valid , I would love to contribute and make this change

@manasanavuduri
Copy link

manasanavuduri commented Sep 30, 2023

@0xJaskeerat : working on this ?

@vatsaakash
Copy link

@manasanavuduri I have already submitted the PR please review it and let me know if any changes are required.

Thanks

@0xJaskeerat
Copy link
Author

@0xJaskeerat : working on this ?

Hey @manasanavuduri I was not well so was not able to contribute to this . Anyways its good to see @vatsaakash has done that !!!

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

No branches or pull requests

3 participants