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

Confusion in the links on the Contributing Guidelines #317

Open
glebkema opened this issue Oct 5, 2019 · 2 comments · May be fixed by #346
Open

Confusion in the links on the Contributing Guidelines #317

glebkema opened this issue Oct 5, 2019 · 2 comments · May be fixed by #346
Assignees
Labels

Comments

@glebkema
Copy link
Contributor

glebkema commented Oct 5, 2019

I noticed 4 links to the contributing guidelines. But they are all different and 2 of them do not work.

contributing-1
contributing-3

contributing-2

contributing-4

I think it’s important to put things in order because all beginners should read this document and because in each PR we put a cross I have read the CONTRIBUTING document.

@jeffpaul
Copy link
Member

jeffpaul commented Nov 7, 2019

@glebkema thanks for the feedback, what you're seeing is definitely odd and something that should get cleaned up.

The links on the Issues page are utilizing the 10up default Contributing Guidelines markdown file, so that'll likely be resolved by creating a replica of https://github.com/10up/.github/blob/master/CONTRIBUTING.md and customizing it as necessary for the Engineering Best Practices.

The Contribute page, honestly, was not a page I was aware of and looks to be a hidden page in the GitHub UI. Resolving for the Issues page above will likely (hopefully?) resolve this dead link.

The PR template is also using the 10up default PR template file, so that'll likely be resolved by creating a replica of https://github.com/10up/.github/blob/master/.github/PULL_REQUEST_TEMPLATE.md and customizing it as necessary for the Engineering Best Practices. I'll make a note that removing the link in the .github repo version of this file is likely warranted to avoid this same scenario for other repos inheriting this file.

Finally, we may want to link to the newly created CONTRIBUTING.md file from the https://10up.github.io/Engineering-Best-Practices/#contributing section to provide more details than what's currently stated.

@timwright12 if you're 👍 on these changes, then I'll work on a PR for you to review.

@jeffpaul jeffpaul added the Bug label Nov 7, 2019
@tlovett1
Copy link
Member

tlovett1 commented Sep 8, 2020

Those changes sound good to me @jeffpaul

@jeffpaul jeffpaul self-assigned this Oct 7, 2020
@jeffpaul jeffpaul linked a pull request Oct 7, 2020 that will close this issue
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants