Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Add more detailed contributing information #121

Merged
merged 1 commit into from
May 14, 2020

Conversation

jaredmorgs
Copy link
Contributor

Add a basic procedure about how to contribute a fix that isn't a typo.

This enhancement was identified in the slack #general room.

Add a basic procedure about how to contribute a fix that isn't a typo.

This enhancement was identified in the slack #general room.
@jaredmorgs jaredmorgs self-assigned this May 13, 2020
@jaredmorgs jaredmorgs added the improve For any suggestions about how to make templates better. label May 13, 2020
@mgan59
Copy link
Contributor

mgan59 commented May 13, 2020

👍 Looks good!

Copy link
Contributor

@flicstar flicstar left a comment

Choose a reason for hiding this comment

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

+1 Looks good

@camerons
Copy link
Member

I'm -0 (non blocking vote against).
I think the idea is right, but some more is required.

  • We are introducing a conflict in advice further in the doc. (Update suggests notifying slack, below it suggests email list).
  • Further down it talks about issue tracking, and the inserted section is also talking about issue tracking.
  • In our weekly meeting one of the main issues Max identified is permissions granted to approve pull requests. I think it is worth noting that this is going to become more rigorous over time. Currently we trust of Project Steering Committee tech writers to make a call on accept/reject. But we shouldn't accept our own pull requests.

Separate to this pull request, we should consider grouping this document in the same repository as our other governance docs: E.g.: https://github.com/thegooddocsproject/governance/blob/master/ProjectSteeringCommittee.md

@jaredmorgs
Copy link
Contributor Author

@camerons I think if we get this PR applied then we can take a closer look at the other sections of this file and clean them up a bit.

For now, lets "iterate, not gold plate" and get this contributing info in.

@jaredmorgs
Copy link
Contributor Author

@flicstar or @camerons can you Squash and Merge if you are OK with the closing comment I made please?

@camerons
Copy link
Member

I'm about to merge this pull request in line with Jared's suggestion of iterate rather than gold plate.

@camerons camerons merged commit d23f5f2 into master May 14, 2020
@camerons camerons deleted the jlm-improve-contributing-section branch May 14, 2020 18:58
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
improve For any suggestions about how to make templates better.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants