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.

Sign up for GitHub

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

Jump to bottom

Consolidate and update "Contributing" docs (in progress) #3177

Open

apinnick opened this issue Jul 30, 2024 · 0 comments

Contributor

apinnick commented Jul 30, 2024 •

edited

Loading

We have a lot of files and links for contributing to this repository:

foreman-documentation/readme
foreman-documentation/CONTRIBUTING.md
foreman-documentation/guides/README.md

Suggestions for improvement:

Consolidate files.
Remove obsolete information, duplicated info, and broken links.
Edit guidelines so that they are not too overwhelming.
Add link to RHSSG.
Perhaps recommend installing Vale locally and running it on PR. The Vale linter in GitHub only looks for "errors". Most of the ISG and RHSSG guidelines are "warnings" or "suggestions".

ekohl linked a pull request

that will close this issue

Document how to populate foreman-contributors.adoc #3202

Merged

9 tasks

ekohl removed a link to a pull request

Document how to populate foreman-contributors.adoc #3202

Merged

9 tasks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment