Add initial contributing doc#185
Add initial contributing doc#185lmb merged 3 commits intocilium:masterfrom twpayne:pr/twpayne/contributing-doc
Conversation
|
Also see #184 and https://cilium.slack.com/archives/CKC55JL8L/p1607371973036400 for discussion. |
|
Could you add a commit that only renames readme.md? Seems like it's throwing off the diff somehow, I can't tell what has changed. The contribution guidelines sgtm largely, I think we should include that new features have to be accompanied by tests, and that it's best to drop into the slack channel before starting work on a big feature to discuss the design. I'm not super fussed about commit messages, the more detail the better, etc. |
Signed-off-by: Tom Payne <tom@isovalent.com>
Signed-off-by: Tom Payne <tom@isovalent.com>
There was a problem hiding this comment.
Couple of minor spelling nits below.
Do we want to mention something about describing the problems as well? eg:
"When submitting pull requests, consider writing details about what problem you are solving and why the proposed approach solves that problem in commit messages and/or the pull request description to help future library users and maintainers to reason about the changes."
Signed-off-by: Tom Payne <tom@isovalent.com>
|
Thanks for the feedback, PR updated. |
|
Gentle ping: can this be merged now? |
|
This may be specific to people's situation, but leaving it here in case useful to others; if you're running into issues because git doesn't like the case-only filename change (
|
|
Hmm.. that config can actually be a bit of a pain as well, git checkout master
error: The following untracked working tree files would be overwritten by checkout:
vendor/github.com/cilium/ebpf/readme.md
Please move or remove them before you switch branches.
Aborting |
It came up in yesterday's Cilium meeting that this project does not have a contributing doc. This PR adds an initial one and also tidies up the README a little.
Fixes #184
cc @joestringer