chocolatey / docs

https://docs.chocolatey.org - new docs website
Apache License 2.0
160 stars 181 forks source link

PR template references non-existent CONTRIBUTING.md #591

Open joeyparrish opened 2 years ago

joeyparrish commented 2 years ago

What You Are Seeing?

The docs PR template insists that you read CONTRIBUTING.md in very strong language, but there is no such file in the docs repo.

https://github.com/chocolatey/docs/blob/8c242f4a58f7d19ab6fe11714582ced36e5db732/.github/PULL_REQUEST_TEMPLATE.md?plain=1#L4

What is Expected?

The docs PR template should link to the appropriate file. If it's in another repo, the link should be updated. If there's no longer a relevant CONTRIBUTING.md file for the docs repo, the template should be updated to provide up-to-date guidance.

How Did You Get This To Happen? (Steps to Reproduce)

  1. Try opening a docs PR.
  2. Read the large comment at the top of the PR template.
pauby commented 2 years ago

Thanks for raising this. You're right, there isn't a doc here or in the .github repository, either. We need to get this created and added.