Adding CONTRIBUTING_GUIDELINES.md #864

PikBot · 2018-06-09T02:22:33Z

Signed-off-by: Prakriti prakritibansal98@gmail.com

Which problem is this PR solving?

Adding general contribution guidelines for uniformity across all repos.
refs Replace "good commit message" guidelines across all repos #771

Short description of the changes

Adding general contribution guidelines.

Signed-off-by: Prakriti <prakritibansal98@gmail.com>

codecov · 2018-06-09T02:30:30Z

Codecov Report

Merging #864 into master will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff          @@
##           master   #864   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files         121    121           
  Lines        5997   5997           
=====================================
  Hits         5997   5997

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 10252fe...996aa6d. Read the comment docs.

yurishkuro · 2018-06-09T04:00:53Z

CONTRIBUTING_GUIDELINES.md

+    * Use the imperative mood in the subject line
+    * Wrap the body at 72 characters
+    * Use the body to explain _what_ and _why_ instead of _how_
+* Uses the active voice (vs. [passive voice](https://www.grammarly.com/blog/a-scary-easy-way-to-help-you-find-passive-voice/)) to make it clear when the user has to perform an action and when actions happen automatically.


this seems unnecessary. Was this copied from the documentation repo?

Yes, it seemed to contain all of the required content for general guidelines.

yurishkuro · 2018-06-09T04:01:49Z

CONTRIBUTING_GUIDELINES.md

+    * Use the body to explain _what_ and _why_ instead of _how_
+* Uses the active voice (vs. [passive voice](https://www.grammarly.com/blog/a-scary-easy-way-to-help-you-find-passive-voice/)) to make it clear when the user has to perform an action and when actions happen automatically.
+* Has been spellchecked and uses proper [grammar](https://www.grammarly.com/).
+* Has been written in plain language and avoids jargon. Remember, the people reading the documentation know much less about the project than you do.


these 2 lines - same, not a general guideline. We should use CONTRIBUTING from the main repo as the starting point.

yurishkuro · 2018-06-09T04:02:03Z

CONTRIBUTING_GUIDELINES.md

+* Has been written in plain language and avoids jargon. Remember, the people reading the documentation know much less about the project than you do.
+* Each commit must be signed by the author ([see below](#sign-your-work)).
+
+Once the PR is approved and merged, [readthedocs][project] will automatically rebuild the docs.


reference to readthedocs not applicable

yurishkuro · 2018-06-09T04:02:30Z

CONTRIBUTING_GUIDELINES.md

+of the [Apache License](LICENSE).
+
+If you are adding a new file it should have a header like below.  The easiest
+way to add such header is to run `make fmt`.


make fmt won't work in every repo

yurishkuro · 2018-06-09T04:02:52Z

CONTRIBUTING_GUIDELINES.md

+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.


depending on the language of the repo, the comment may start with #

yurishkuro · 2018-06-09T04:03:14Z

CONTRIBUTING_GUIDELINES.md

+
+```
+git config --add alias.amend "commit -s --amend"
+git config --add alias.c "commit -s"


this never worked for me, maybe we can delete it

yurishkuro · 2018-06-09T04:03:24Z

CONTRIBUTING_GUIDELINES.md

+git config --add alias.c "commit -s"
+```
+
+[project]: https://readthedocs.org/projects/jaeger/


not relevant

Signed-off-by: Prakriti <prakritibansal98@gmail.com>

yurishkuro · 2018-06-10T14:24:08Z

CONTRIBUTING_GUIDELINES.md

+changes ahead of time will make the contribution process smooth for everyone.
+
+Once we've discussed your changes and you've made your updates, then open your PR. Your
+pull request is most likely to be accepted if it:


English doesn't work in these bullets

yurishkuro · 2018-06-10T14:25:01Z

CONTRIBUTING_GUIDELINES.md

+## Making A Change
+
+*Before making any significant changes, please open an
+issue.* Discussing your proposed


I think we should elaborate on what we're looking for in new issues (essentially the questions the new-issue-template is asking)

yurishkuro · 2018-06-10T14:25:39Z

CONTRIBUTING_GUIDELINES.md

+issue.* Discussing your proposed
+changes ahead of time will make the contribution process smooth for everyone.
+
+Once we've discussed your changes and you've made your updates, then open your PR. Your


similarly, we should include some guidelines on what should be in the PR description (similar to the template).

Signed-off-by: Prakriti <prakritibansal98@gmail.com>

…trib-guide

Signed-off-by: Prakriti <prakritibansal98@gmail.com> - Fixing minor English errors

yurishkuro

minor correction, lgtm otherwise

yurishkuro · 2018-06-12T05:31:29Z

CONTRIBUTING_GUIDELINES.md

+* Proposal - what do you suggest to solve the problem or improve the existing situation?
+* Any open questions to address
+
+Discussing your proposed changes ahead of time will make the contribution process smooth for everyone. Once we've discussed your changes and you've made your updates, then open your PR. Each PR must contain:


s/Once we've discussed your changes and you've made your updates, then open your PR./Once the approach is agreed upon, make your changes and open a pull request (PR)./

s/Each PR must contain/Each PR should describe:/

yurishkuro · 2018-06-12T05:33:26Z

CONTRIBUTING_GUIDELINES.md

+* Any open questions to address
+
+Discussing your proposed changes ahead of time will make the contribution process smooth for everyone. Once we've discussed your changes and you've made your updates, then open your PR. Each PR must contain:
+* Which problem is this PR solving?


Which problem it is solving. Normally it should be simply a reference to the corresponding issue, e.g. Resolves #123.

What changes are made to achieve that.

Should I remove the "short description of the changes" point?

I meant to replace the bullet points with my version.

yurishkuro · 2018-06-12T05:34:34Z

CONTRIBUTING_GUIDELINES.md

+## Making A Change
+
+*Before making any significant changes, please open an
+issue.* Each issue must address the following:


s/Each issue must address the following/Each issue should describe the following:/

yurishkuro · 2018-06-12T05:35:03Z

CONTRIBUTING_GUIDELINES.md

+* Which problem is this PR solving?
+* Short description of the changes
+
+Your pull request is most likely to be accepted if each commit:


"each commit" in bold

yurishkuro · 2018-06-12T05:35:56Z

CONTRIBUTING_GUIDELINES.md

+* Short description of the changes
+
+Your pull request is most likely to be accepted if each commit:
+* Has a [good commit message](https://chris.beams.io/posts/git-commit/):


s/:/. In summary:/

A little unsure about where this change is to be added? After "each commit, in summary:" ?

Sorry, I was using regexp syntax, "replace : with ...". So

Has a [good commit message](https://chris.beams.io/posts/git-commit/):]. In summary:

yurishkuro · 2018-06-12T05:38:29Z

CONTRIBUTING_GUIDELINES.md

+By contributing your code, you agree to license your contribution under the terms
+of the [Apache License](LICENSE).
+
+If you are adding a new file it should have a header like below. Depending on the language of the repository, the may start with a '#'.


Replace

Depending on the language of the repository, the may start with a '#'./

with

In some languages, e.g. Python, you may need to change the comments to start with #. The easiest way is to copy the header from one of the existing source files and make sure the year is current and the copyright says "The Jaeger Authors".

Signed-off-by: Prakriti <prakritibansal98@gmail.com>

yurishkuro · 2018-06-12T23:53:40Z

thanks!

* master: Add back quotes Adding CONTRIBUTING_GUIDELINES.md (jaegertracing#864) Close span writer in standalone (jaegertracing#863) Fix Process IP problem/inconsistency (jaegertracing#821) (jaegertracing#865) Use NewSpanID()/NewTraceID() instead of type-specific intializations (jaegertracing#861) Do not create duplicate child-of reference from parentSpanId (jaegertracing#860) Switch to codecov (jaegertracing#857) Log configuration options for memory storage (jaegertracing#852) Add jpkrohling to maintainers / code owners (jaegertracing#851)

Adding CONTRIBUTING_GUIDELINES.md

8eadbbc

Signed-off-by: Prakriti <prakritibansal98@gmail.com>

PikBot requested review from black-adder, jpkrohling, pavolloffay, vprithvi and yurishkuro as code owners June 9, 2018 02:22

yurishkuro reviewed Jun 9, 2018

View reviewed changes

Updating required changes in CONTRIBUTING_GUIDELINES.md

75ca82c

Signed-off-by: Prakriti <prakritibansal98@gmail.com>

yurishkuro reviewed Jun 10, 2018

View reviewed changes

PikBot force-pushed the contrib-guide branch from f2a96e1 to 75ca82c Compare June 11, 2018 18:23

PikBot added 4 commits June 12, 2018 01:46

Adding CONTRIBUTING_GUIDELINES.md

718f8c7

Signed-off-by: Prakriti <prakritibansal98@gmail.com>

Updating required changes in CONTRIBUTING_GUIDELINES.md

2a1e2e1

Signed-off-by: Prakriti <prakritibansal98@gmail.com>

Merge branch 'contrib-guide' of github-private:PikBot/jaeger into con…

c4c4204

…trib-guide

Adding new issue and PR guidelines

50b2d06

Signed-off-by: Prakriti <prakritibansal98@gmail.com> - Fixing minor English errors

yurishkuro reviewed Jun 12, 2018

View reviewed changes

Minor fixes in CONTRIBUTING_GUIDELINES.md

996aa6d

Signed-off-by: Prakriti <prakritibansal98@gmail.com>

yurishkuro approved these changes Jun 12, 2018

View reviewed changes

yurishkuro merged commit 5633f3d into jaegertracing:master Jun 12, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding CONTRIBUTING_GUIDELINES.md #864

Adding CONTRIBUTING_GUIDELINES.md #864

PikBot commented Jun 9, 2018

codecov bot commented Jun 9, 2018 •

edited

Loading

yurishkuro Jun 9, 2018

PikBot Jun 9, 2018

yurishkuro Jun 9, 2018

yurishkuro Jun 9, 2018

yurishkuro Jun 9, 2018

yurishkuro Jun 9, 2018

yurishkuro Jun 9, 2018

yurishkuro Jun 9, 2018

yurishkuro Jun 10, 2018

yurishkuro Jun 10, 2018

yurishkuro Jun 10, 2018

yurishkuro left a comment

yurishkuro Jun 12, 2018

yurishkuro Jun 12, 2018

PikBot Jun 12, 2018

yurishkuro Jun 12, 2018

yurishkuro Jun 12, 2018

yurishkuro Jun 12, 2018

yurishkuro Jun 12, 2018

PikBot Jun 12, 2018

yurishkuro Jun 12, 2018

yurishkuro Jun 12, 2018

yurishkuro commented Jun 12, 2018

Adding CONTRIBUTING_GUIDELINES.md #864

Adding CONTRIBUTING_GUIDELINES.md #864

Conversation

PikBot commented Jun 9, 2018

Which problem is this PR solving?

Short description of the changes

codecov bot commented Jun 9, 2018 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yurishkuro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yurishkuro commented Jun 12, 2018

codecov bot commented Jun 9, 2018 •

edited

Loading