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 contributing doc #106

Merged
merged 3 commits into from
Oct 21, 2022
Merged

Add contributing doc #106

merged 3 commits into from
Oct 21, 2022

Conversation

programmiri
Copy link
Contributor

📜 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 made some sentences more clear to read in order to make it more accessible (based on suggestions from Hemmingway.app)
    • I added a paragraph about the code of conduct and linked or COC. I feel it's important to make people aware of us following a COC, right in probably one of the first files a contributor would look at.
  • 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

@programmiri
Copy link
Contributor Author

**❓ Question **

The linked article about commit messages also recommends:

  • always start description with a capitalised letter
  • never use a period at the end of a description

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 🙈

@programmiri programmiri self-assigned this Oct 19, 2022
@programmiri programmiri added the documentation Improvements or additions to documentation label Oct 19, 2022
@jlprat jlprat mentioned this pull request Oct 19, 2022
6 tasks
Copy link
Contributor

@jlprat jlprat left a 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

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@programmiri programmiri requested a review from a team as a code owner October 21, 2022 11:19
CONTRIBUTING.md Outdated Show resolved Hide resolved
Co-authored-by: Josep Prat <josep.prat@aiven.io>
Copy link
Contributor

@jlprat jlprat left a comment

Choose a reason for hiding this comment

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

LGTM

@jlprat jlprat merged commit 68434f7 into main Oct 21, 2022
@jlprat jlprat deleted the add-contributing-doc branch October 21, 2022 11:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add guideline for commit messages
2 participants