Skip to content

Add initial contributing doc#185

Merged
lmb merged 3 commits intocilium:masterfrom
twpayne:pr/twpayne/contributing-doc
Dec 15, 2020
Merged

Add initial contributing doc#185
lmb merged 3 commits intocilium:masterfrom
twpayne:pr/twpayne/contributing-doc

Conversation

@twpayne
Copy link
Copy Markdown
Contributor

@twpayne twpayne commented Dec 8, 2020

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

@tklauser
Copy link
Copy Markdown
Member

tklauser commented Dec 8, 2020

Also see #184 and https://cilium.slack.com/archives/CKC55JL8L/p1607371973036400 for discussion.

@lmb
Copy link
Copy Markdown
Contributor

lmb commented Dec 8, 2020

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>
@twpayne
Copy link
Copy Markdown
Contributor Author

twpayne commented Dec 8, 2020

Done:

  • Added separate rename commit.
  • Changes to README.md are now in f66f792. It's basically just line wrapping, consistent punctuation, consistent Markdown styling, adding a License section, and adding a # before the Slack channel name.
  • Updated CONTRIBUTING.md to include what @lmb requested.

Copy link
Copy Markdown
Member

@joestringer joestringer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
@twpayne
Copy link
Copy Markdown
Contributor Author

twpayne commented Dec 9, 2020

Thanks for the feedback, PR updated.

@twpayne
Copy link
Copy Markdown
Contributor Author

twpayne commented Dec 15, 2020

Gentle ping: can this be merged now?

@lmb lmb merged commit 997a7a8 into cilium:master Dec 15, 2020
@twpayne twpayne deleted the pr/twpayne/contributing-doc branch December 15, 2020 09:11
@thaJeztah
Copy link
Copy Markdown
Contributor

thaJeztah commented Mar 27, 2021

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 (readme.md -> README.md);

  • if you're on a case-insensitive (but case-preserving) filesystem (macOS, Windows): configure git to not ignore case-only changes;

    git config core.ignorecase false
  • if your CI doesn't like this (for example, runc CI failed on the rename go.mod: github.com/cilium/ebpf v0.4.0 opencontainers/runc#2875); adding a .gitconfig to your github repository to make the change configuration can help; (edit: ignore this: github doesn't use that file)

@thaJeztah
Copy link
Copy Markdown
Contributor

thaJeztah commented Mar 27, 2021

Hmm.. that config can actually be a bit of a pain as well, because there's no content changes in the readme git still gets confused when switching branches 😓

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Formalize contributing guide

5 participants