Introduce Contribution Doc #151
Conversation
awgreene
force-pushed
the
contributing-guide
branch
from
017acc6
to
879495d
Compare
awgreene
force-pushed
the
contributing-guide
branch
from
879495d
to
768c125
Compare
CONTRIBUTING.md
Outdated
| When contributing changes that require a new dependency, check whether it's feasible to directly vendor that | ||
| code [without introducing a new dependency](https://go-proverbs.github.io/). | ||
|
|
||
| Currently, PRs required at least one approval from a operator-controller maintainer in order to get merged. |
There was a problem hiding this comment.
Can we add a section mentioning requirements to open a PR. Something like this. Since this repository is in a fairly new state, we could ask for PR description, tests, relevant documentation as some tips for opening a PR.
There was a problem hiding this comment.
That's info that could be added to the PR template.
There was a problem hiding this comment.
I think this is covered by the existing PR template.
There was a problem hiding this comment.
@varshaprasad96 please mark this as resolved if you agree.
awgreene
force-pushed
the
contributing-guide
branch
from
768c125
to
50f2cf5
Compare
Signed-off-by: Alexander Greene <greene.al1991@gmail.com>
awgreene
force-pushed
the
contributing-guide
branch
from
50f2cf5
to
b73a39e
Compare
CONTRIBUTING.md
Outdated
|
|
||
| ## Contribution flow | ||
|
|
||
| Any new contribution should be accompanied by a new or existing issue. This issue can help track work, discuss the |
There was a problem hiding this comment.
Although we mention trivial fixes don't need a separate issue; where's the dividing line? A PR itself could be a bug report and fix in one, and having to create an issue (which, unrelatedly, share the same number spaces as PRs) seems like duplication of effort.
There was a problem hiding this comment.
Fair point, I think we just need to establish that:
- If you contribute regularly, its clear that we drive the project with GitHub issues
- If a one-off contribution is made, a lack of an issue doesn't prevent the work from being contributed.
awgreene
force-pushed
the
contributing-guide
branch
2 times, most recently
from
ad34f55
to
6f2fa01
Compare
awgreene
force-pushed
the
contributing-guide
branch
from
6f2fa01
to
2d097ed
Compare
No description provided.