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

CONTRIBUTING: Add a contributing file #387

Merged
merged 2 commits into from Jun 17, 2020

Conversation

wking
Copy link
Member

@wking wking commented Jun 17, 2020

Based on the installer's, but with a few local changes like:

  • No section about mock tests, because we don't have any.
  • No section about the Developer Certificate of Origin, because we don't use Signed-off-by, and I'm skeptical about how binding a CONTRIBUTING.md -> DCO link is vs. a contributor claiming "I just wrote a commit; I didn't read all the docs in the repo first". If we decide that a CONTRIBUTING.md -> DCO link is binding, we can always add it later.
  • Trimmed down section about linting, because we don't do as much of that as the installer.
  • One sentence per line, so we don't have to worry about rewrapping (and complicating diff/blame) as we edit this content going forward.
  • Whatever else seemed reasonable when I went through ;).

Also wash the repository through go fmt ./....

Generated with:

  $ go fmt ./...

using:

  $ go version
  go version go1.13.5 linux/amd64
@openshift-ci-robot openshift-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 17, 2020
@wking wking force-pushed the contributing-docs branch 2 times, most recently from 2e183d1 to aff7628 Compare June 17, 2020 04:36
CONTRIBUTING.md Outdated Show resolved Hide resolved
Based on [1], but with a few local changes like:

* No section about mock tests, because we don't have any.
* No section about the Developer Certificate of Origin, because we
  don't use Signed-off-by, and I'm skeptical about how binding a
  CONTRIBUTING.md -> DCO link is vs. a contributor claiming "I just
  wrote a commit; I didn't read all the docs in the repo first".  If
  we decide that a CONTRIBUTING.md -> DCO link is binding, we can
  always add it later.
* Trimmed down section about linting, because we don't do as much of
  that as the installer.
* One sentence per line, so we don't have to worry about rewrapping
  (and complicating diff/blame) as we edit this content going forward.
* Whatever else seemed reasonable when I went through ;).

[1]: https://github.com/openshift/installer/blob/4e46d0a347533263903beb3349a33f53eee7a6c2/CONTRIBUTING.md
@jottofar
Copy link
Contributor

/lgtm

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Jun 17, 2020
@openshift-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jottofar, wking

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-merge-robot openshift-merge-robot merged commit cca8239 into openshift:master Jun 17, 2020
@wking wking deleted the contributing-docs branch June 17, 2020 19:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants