-
-
Notifications
You must be signed in to change notification settings - Fork 64
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
Update readme to point to updated contribution guideline pages #68
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me. Not sure if we should add please
to the other sentences as well (as we do in the last one).
README.md
Outdated
- If you need support with the project, read [the support documentation](/laminas/.github/blob/main/SUPPORT.md). | ||
- If you wish to contribute to the project, read the [contributing guidelines](/laminas/.github/blob/main/CONTRIBUTING.md) as well as the [Code of Conduct](/laminas/.github/blob/main/CODE_OF_CONDUCT.md). | ||
- For reporting security issues, please review our [security policy](/laminas/.github/blob/main/SECURITY.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unfortunately, the links do not work. GitHub transform the links to:
https://github.com/laminas/laminas-diactoros/blob/2.7.x/laminas/.github/blob/main/SUPPORT.md
https://github.com/laminas/laminas-diactoros/blob/2.7.x/laminas/.github/blob/main/CONTRIBUTING.md
https://github.com/laminas/laminas-diactoros/blob/2.7.x/laminas/.github/blob/main/SECURITY.md
Use https://github.com/laminas/.github/blob/main/SECURITY.md instead.
This PR copies in (and slightly amends) the relevant information for getting support and contributing to the project to the README, to make it as easy as possible for people to do one or both of these. Signed-off-by: Matthew Setter <[email protected]>
Instead of bringing the org-wide documents into the repository, the goal is to link to the org-wide documents from the `README.md` file of each repository. By placing the content at the end of the file, we can automate adding the information, and it's in a location users will likely look for it. Signed-off-by: Matthew Weier O'Phinney <[email protected]>
3ed7648
to
6731be0
Compare
Adjusted absolute references as per @froschdesign's feedback, and rebased. Thanks @settermjd! |
Description
Add contributing and support documentation to the end of the README. Thanks for the corrections, @weierophinney.