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

Update Adding Content steps to use GitHub Issue setup #96

Open
strixy16 opened this issue Nov 12, 2024 · 0 comments
Open

Update Adding Content steps to use GitHub Issue setup #96

strixy16 opened this issue Nov 12, 2024 · 0 comments
Labels

Comments

@strixy16
Copy link
Contributor

Which content needs to be updated?
The current version of the Adding Content page under Contributing doesn't include the creating an issue step. So if someone makes a branch, it might not automatically associate with a branch unless they understand the naming convention on the commits/PRs.

Describe the update
Make the first step read:

1. Select or Create an Issue

Navigate to the Issues section of the repo and select an existing issue or continue on from the Issue you created in the Submitting Issues section.
Assign yourself to the issue if it's not already assigned.
Open the issue and click on the "Create a branch" link under Development on the right side of the page.
Follow this naming convention (same as what's there right now)
Run the lines of code provided (git fetch, git checkout branchname)

With this change, step 4 can also be updated since users won't need to run the set-upstream part anymore, so it will become

git add .
git commit -m "Add new getting started page"
git push 

Reason for Update
We want to ensure every branch is associated with an existing issue so conversation and documentation can be followed properly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Backlog
Development

No branches or pull requests

1 participant