Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Align Contributors' Guides #171

Closed
Loquacity opened this issue Nov 29, 2020 · 1 comment · Fixed by #172
Closed

Align Contributors' Guides #171

Loquacity opened this issue Nov 29, 2020 · 1 comment · Fixed by #172
Assignees
Labels
improve For any suggestions about how to make templates better. process Process or governance issue. Project team to decide.

Comments

@Loquacity
Copy link
Member

Describe the bug
We have several locations with Contributors' Guides, let's align them in the correct place:

  • .github directory: This is the correct place, so that the repo shows that we have a Contributors' Guide in the Insights tab. However, doing a PR to this directory is a little tricky.
  • Templates repo CONTRIBUTING.md: This has the right filename, but is only a stub.
  • Incubator repo base-template/contributors-guide.md: This has content, but is in the wrong location.

To Reproduce
Steps to reproduce the behavior:

  1. Go to different locations in the project
  2. See different contributors' Guides
  3. Be confused

Expected behavior
A single guide with comprehensive information, in the .github directory, and available in the GH Insights tab.

@Loquacity Loquacity self-assigned this Nov 29, 2020
@Loquacity Loquacity added improve For any suggestions about how to make templates better. process Process or governance issue. Project team to decide. labels Nov 29, 2020
@barbaricyawps
Copy link
Contributor

Thanks for being willing to take this on, @Loquacity . This issue is related to a task needed for the website: thegooddocsproject/website-hugo#22

Would you be willing to let me know what you consolidate so that we can get them up on the website?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
improve For any suggestions about how to make templates better. process Process or governance issue. Project team to decide.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants