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

Moving contributor guide to expected location #1446

Closed
terriko opened this issue Nov 24, 2021 · 2 comments · Fixed by #1467
Closed

Moving contributor guide to expected location #1446

terriko opened this issue Nov 24, 2021 · 2 comments · Fixed by #1467
Labels
documentation Documentation changes good first issue Good for newcomers

Comments

@terriko
Copy link
Contributor

terriko commented Nov 24, 2021

Our contributor guide is currently found in https://github.com/intel/cve-bin-tool/blob/main/doc/CONTRIBUTORS.md

It looks like goodfirstissue.dev, Github, and others are starting to expect documentation for contributors to appear in /CONTRIBUTING.md

I can't really think of any reason to maintain a slightly different filename, so I propose renaming this guide to CONTRIBUTING.md and moving it to the root directory, then leaving a symlink in doc/ so that it will be picked up correctly by sphinx and build for Read The Docs. (similar to what we do for README.md right now) You'll need to double-check that the docs build correctly after that's done and that there's no broken links to the old doc.

This is probably a good first issue for someone who wants to learn to build the docs.

@terriko terriko added good first issue Good for newcomers documentation Documentation changes labels Nov 24, 2021
@ashok-arora
Copy link

@terriko Can I work on this?

@terriko
Copy link
Contributor Author

terriko commented Dec 9, 2021

@ashok-arora sure, have fun!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation changes good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants