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

Add contribution guide #70

Merged
merged 1 commit into from Sep 28, 2020
Merged

Add contribution guide #70

merged 1 commit into from Sep 28, 2020

Conversation

MarkusH
Copy link
Contributor

@MarkusH MarkusH commented Sep 17, 2020

Summary of the changes / Why this is an improvement

Refs #63

Checklist

  • CLA is signed

Copy link
Member

@mfussenegger mfussenegger left a comment

Choose a reason for hiding this comment

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

lgtm

Although I do wonder if we should centralize the parts that are not necessarily project specific, like the git commit hygiene stuff. I think @infoverload also brought that topic up before?

@matthijskrul
Copy link
Contributor

Similar from me - looks good in principle, but maybe the Git stuff ought to be located somewhere more obvious. (Though no harm in reminders, either.) Is there anything Kubernetes specific that needs adding? That's something a dev can better judge

@christianbader
Copy link

@matthijskrul @mfussenegger Agree, but I think almost non of the text is necessarily project specific and it's almost ident with the CrateDB contribution guide. Would it then make sense to have one central contribution guide in our docs and just link to it and mention the project specific parts like debug instructions in the individual repository?

@christianbader
Copy link

christianbader commented Sep 18, 2020

We do this already for other repositories:
https://github.com/crate/croud/blob/master/CONTRIBUTING.rst

@mfussenegger
Copy link
Member

See also recent edits made by @infoverload in crate/crate#10523

@MarkusH
Copy link
Contributor Author

MarkusH commented Sep 28, 2020

Thanks for your input. How would you like to move forward? @infoverload do you have a preferred way?

@MarkusH
Copy link
Contributor Author

MarkusH commented Sep 28, 2020

I briefly talked to @infoverload and we agreed to -- while aiming for a centralized contribution guide -- merging the PR for now to not have this block Hacktoberfest.

@MarkusH MarkusH merged commit 3f8ced6 into master Sep 28, 2020
@MarkusH MarkusH deleted the mh/contribution-guide branch September 28, 2020 12:37
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.

None yet

4 participants