Skip to content

Conversation

@justwheel
Copy link
Member

This commit follows up on previous Runbook PRs, FOSSRIT/runbook#30 and
FOSSRIT/runbook#32. Now that contributing guidelines and advice about
maintaining this site lives in the Runbook, the duplicated info is
removed from this repo. Instead, the reader is redirected to the
Runbook.

Stay D.R.Y. - Don't Repeat Yourself!

Closes #86.

@justwheel justwheel added improvement Improves on something that already exists documentation Improvements or additions to documentation labels Feb 20, 2020
@justwheel justwheel requested a review from a team February 20, 2020 21:12
@justwheel justwheel self-assigned this Feb 20, 2020
@justwheel justwheel requested review from Nolski and wilfriedE and removed request for a team February 20, 2020 21:12
@justwheel justwheel force-pushed the change/readme-contributing branch 2 times, most recently from 75473e4 to 8878efc Compare February 20, 2020 21:32

More detailed steps will be documented in the future.
For now, if you want to contribute, submit a new pull request.
See the [_Website (fossrit.github.io)_](https://runbook.fossrit.community/infra/website/ "Website (fossrit.github.io) - FOSSRIT Runbook") page in the [FOSSRIT Runbook](https://runbook.fossrit.community/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you keeping this in a single file on purpose? An alternative is to copy this section, and paste it in the How to Contribute section of the ReadMe.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@10eMyrT I am! The GitHub user interface makes the CONTRIBUTING.md more visible in the GitHub.com interface. Instead of deleting the file, I want to benefit from the improved visibility on GitHub.com but at least point out to the Runbook if someone does come across it.

Comment on lines +16 to +18
## How to contribute

For help with contributing and making a development environment, see [CONTRIBUTING.md](https://github.com/FOSSRIT/fossrit.github.io/blob/master/.github/CONTRIBUTING.md).
See the [_Website (fossrit.github.io)_](https://runbook.fossrit.community/infra/website/ "Website (fossrit.github.io) - FOSSRIT Runbook") page in the [FOSSRIT Runbook](https://runbook.fossrit.community/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we are not referring to the CONTRIBUTING.md file any more, copying and pasting sounds better to me.

Copy link
Member

@Serubin Serubin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor typo - otherwise looks great

justwheel added a commit that referenced this pull request Feb 25, 2020
Signed-off-by: Justin W. Flory <git@jwf.io>
This commit follows up on previous Runbook PRs, FOSSRIT/runbook#30 and
FOSSRIT/runbook#32. Now that contributing guidelines and advice about
maintaining this site lives in the Runbook, the duplicated info is
removed from this repo. Instead, the reader is redirected to the
Runbook.

Stay D.R.Y. - Don't Repeat Yourself!

Closes #86.

Signed-off-by: Justin W. Flory <git@jwf.io>
@justwheel justwheel force-pushed the change/readme-contributing branch from b97ddf3 to 3a27d34 Compare February 25, 2020 14:25
@justwheel
Copy link
Member Author

Thanks @10eMyrT and @Serubin for reviewing! Going to merge this now. 🌊

@justwheel justwheel merged commit d661b81 into master Feb 25, 2020
@justwheel justwheel deleted the change/readme-contributing branch February 25, 2020 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation improvement Improves on something that already exists

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Link to Runbook from README/CONTRIBUTING docs

4 participants