🆕 👥 .github: Add contributing guidelines #13
Conversation
jwflory
added
I: contributor experience
jwflory
requested review from
RichardLitt,
georgiamoon,
Erioldoesdesign,
Memo-Es and
a team
|
@RichardLitt, especially seeking your input on the developer environment instructions and if you are able to use these to test PR #11. |
This commit adds contributing guidelines that explains three topics: 1. Contribution process 2. Structure and components 3. How to create a development environment The contribution process suggests we use a governance model known as **lazy consensus**. This model allows a change or new idea to move forward, provided it gets at least one "+1" vote and no "-1" vote from a maintainer. The full context is explained in the document. Additionally, this document also explains how to create a development environment and set up the project. It explains how to clone the git repository and set up the git submodule for the theme, and how to run the Hugo server to get a local preview. This addresses the feedback from @RichardLitt in PR #11 and should unblock that Pull Request as well. Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>
jwflory
force-pushed
the
add/contrib-docs
branch
from
ef55bf7
to
1cf1c3d
Compare
|
|
||
| **What constitutes a vote?** | ||
| In the context of this repository, a vote can mean a review on a Pull Request or a comment on an Issue. | ||
| A maintainer can give a "+1" vote or approve a Pull Request if they agree with the change. |
There was a problem hiding this comment.
I don't think this is our current process. Perhaps something like: "A maintainer can give a general approval by saying something like "+1" or "LGTM", or just approve a PR using GitHub's review feature." Otherwise, this seems dogmatic.
There was a problem hiding this comment.
@RichardLitt My intent was not to capture our current process (do we have one?). I was setting out to document a norm that we could agree on following as a group. Although I'm not sure I see the difference between what I've written here and your proposed edit, unless you are suggesting to strike this entire process?
There was a problem hiding this comment.
I hear you. Your proposal gives off the impression that the only way to vote is to say "+1" or "-1", when those are personal language choices. If someone just wrote "I like this", that would also work for our current process, but the writing here is too restrictive for that use-case. I propose we broaden your writing to include language choices.
There was a problem hiding this comment.
Ah! Yeah, that makes sense and it is fair feedback. I can amend this. I'll probably get to this sometime next week and include any other feedback from other reviewers at the same time.
This commit adds contributing guidelines that explains three topics:
The contribution process suggests we use a governance model known as
lazy consensus. This model allows a change or new idea to move
forward, provided it gets at least one "+1" vote and no "-1" vote from a
maintainer. The full context is explained in the document.
Additionally, this document also explains how to create a development
environment and set up the project. It explains how to clone the git
repository and set up the git submodule for the theme, and how to run
the Hugo server to get a local preview.
This addresses the feedback from @RichardLitt in PR #11 and should
unblock that Pull Request as well.