-
Notifications
You must be signed in to change notification settings - Fork 60
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 contributing doc #106
Add contributing doc #106
Conversation
**❓ Question ** The linked article about commit messages also recommends:
Should we add these also as recommendations (or other rules to form) or is that less important to us? As you can see with my two commit messages in this PR, I'm already inconsistence because I've a hard time not using a . at the end 🙈 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR!
I have some minor tweak-requests to the doc, but otherwise good content and tone
Co-authored-by: Josep Prat <josep.prat@aiven.io>
429eb0a
to
2935898
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
📜 Description
This PR adds a "CONTRIBUTING" file at our root level. We want to provide contributors a better understanding how they can work in our project.
💁 Detailed changes:
adds "CONTRIBUTING.md"
"Contributing Guidelines" are based on existing examples from the aiven repositories
❗️ I've made some slight changes to that:
I added a first draft for creating commit messages. I based the recommendations on the Conventional Commits and How to Write a Git Commit Message. The latter is the article that the aiven internal etiquette for commit messages is also based upon.
Feedback welcome!
I appreciate feedback for this first draft 🙏! The commit message guideline will be grow in the future. I tried to keep it simple for now and e.g. only add prefixes where I felt they will definitely be useful. This should be used as a proposal which we should align upon together.
Resolves: #94
Relates to: #99