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

Update readme to point to updated contribution guideline pages #68

Merged
merged 3 commits into from
Sep 22, 2021

Conversation

settermjd
Copy link
Contributor

Q A
Documentation yes
Bugfix no
BC Break no
New Feature no
RFC no
QA no

Description

Add contributing and support documentation to the end of the README. Thanks for the corrections, @weierophinney.

Copy link
Member

@boesing boesing left a 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
Comment on lines 28 to 30
- 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).
Copy link
Member

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.

settermjd and others added 2 commits September 22, 2021 05:49
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]>
@Ocramius Ocramius changed the base branch from 2.7.x to 2.8.x September 22, 2021 03:51
@Ocramius Ocramius added this to the 2.8.0 milestone Sep 22, 2021
@Ocramius Ocramius assigned Ocramius and unassigned settermjd Sep 22, 2021
@Ocramius
Copy link
Member

Adjusted absolute references as per @froschdesign's feedback, and rebased. Thanks @settermjd!

@Ocramius Ocramius changed the title Update readme Update readme to point to updated contribution guideline pages Sep 22, 2021
@Ocramius Ocramius merged commit 0c26ef1 into laminas:2.8.x Sep 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants