chore: Add Contributing guide #51
Conversation
jfuss
requested review from
Jwilliamsr,
amisevsk,
bmicklea,
gorkem and
javisperez
as code owners
Signed-off-by: Jacob Fuss <jfuss@users.noreply.github.com>
CONTRIBUTING.md
Outdated
| * Release management | ||
| * Issue triage |
There was a problem hiding this comment.
Issue triage and release management are usually reserved for maintainers
There was a problem hiding this comment.
A lot of this was borrowed from KitOps: https://github.com/kitops-ml/kitops/blob/main/CONTRIBUTING.md#ways-to-contribute
I agree issue triage and release management are usually maintainers but included it due to KitOps repo to help align them. I can remove them here and we should then consider removing it from KitOps as well.
| * [New features](https://github.com/kitops-ml/pykitops/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) | ||
| * [Bug fixes](https://github.com/kitops-ml/pykitops/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) | ||
| * [Documentation](https://github.com/kitops-ml/pykitops/issues?q=is%3Aopen+is%3Aissue+label%3Adocumentation) | ||
| * [Builds and CI/CD](https://github.com/kitops-ml/pykitops/issues?q=is%3Aopen+is%3Aissue+label%3Abuild) |
There was a problem hiding this comment.
Should one of these be "filing bugs" or "describing useful new features"? Most of these links are going to be to zero issues at the moment.
| 1. Updating Dependencies: If you add or update dependencies: | ||
|
|
||
| ```shell | ||
| poetry add <dependency> | ||
| ``` | ||
|
|
||
| or for development dependencies: | ||
| ```shell | ||
| poetry add --group dev <dependency> | ||
| ``` |
There was a problem hiding this comment.
Do we have a process for non-maintainer contributors adding dependencies? Usually we'd have to vet licenses / the dependencies themselves.
There was a problem hiding this comment.
They way I have handled this in the past is: The maintainers are responsible for vetting the PR which includes licensing to any new dependencies required. It would be nice to have a License checker built into the GHA though.
Signed-off-by: Jacob Fuss <jfuss@users.noreply.github.com>
* chore: Add Contributing guide Signed-off-by: Jacob Fuss <jfuss@users.noreply.github.com> * Update based on feedback Signed-off-by: Jacob Fuss <jfuss@users.noreply.github.com> --------- Signed-off-by: Jacob Fuss <jfuss@users.noreply.github.com> Co-authored-by: Jacob Fuss <jfuss@users.noreply.github.com> Signed-off-by: Burhan <62214284+Burhan-Q@users.noreply.github.com>
* chore: Add Contributing guide Signed-off-by: Jacob Fuss <jfuss@users.noreply.github.com> * Update based on feedback Signed-off-by: Jacob Fuss <jfuss@users.noreply.github.com> --------- Signed-off-by: Jacob Fuss <jfuss@users.noreply.github.com> Co-authored-by: Jacob Fuss <jfuss@users.noreply.github.com> Signed-off-by: Burhan <62214284+Burhan-Q@users.noreply.github.com>
No description provided.