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.md file #99

Closed
5 of 6 tasks
jlprat opened this issue Oct 17, 2022 · 6 comments · Fixed by #153
Closed
5 of 6 tasks

Add CONTRIBUTING.md file #99

jlprat opened this issue Oct 17, 2022 · 6 comments · Fixed by #153
Assignees
Labels
documentation Improvements or additions to documentation triaged Acknowledged

Comments

@jlprat
Copy link
Contributor

jlprat commented Oct 17, 2022

What is currently missing?

As a newcomer to Klaw, I'd like to know what is expected from me before, during and after contributing.

How could this be improved?

Adding a CONTRIBUTING.md file that defines:

  • the process a contributor needs to follow to work on issues
  • steps to do before submitting a PR
  • what should be included in the PR
  • what does it take to get a PR merged.
  • what should be in the commit

Is this a feature you would work on yourself?

  • I plan to open a pull request for this feature
@jlprat jlprat added documentation Improvements or additions to documentation triaged Acknowledged labels Oct 17, 2022
@clairecharles
Copy link

hey, @jlprat can I work on this?

@jlprat
Copy link
Contributor Author

jlprat commented Oct 19, 2022

Hi @clairecharles There is already a PR for this already: see #106
You are welcome to review the PR though!

@jlprat
Copy link
Contributor Author

jlprat commented Oct 21, 2022

Hi @clairecharles, now the CONTRIBUTING.md file is already present. At the time of this writing these sections are still missing:

  • the process a contributor needs to follow to work on issues
  • steps to do before submitting a PR
  • what should be included in the PR
  • what does it take to get a PR merged

Do you want to take any of these?

@programmiri
Copy link
Contributor

@jlprat - do we have examples in other Aiven OS repos that we want to use / base our text on?

@jlprat
Copy link
Contributor Author

jlprat commented Oct 25, 2022

We currently don't have one with all the steps I think would be needed. But here you have an example done by Akka back when it was Apache licensed: https://github.com/mdedetrich/akka-apache/blob/main/CONTRIBUTING.md

@programmiri
Copy link
Contributor

Thanks! I'll make a draft for this than :)

@programmiri programmiri self-assigned this Oct 26, 2022
@programmiri programmiri linked a pull request Oct 26, 2022 that will close this issue
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 triaged Acknowledged
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants