search

unicef / kindly

GNU Affero General Public License v3.0
24 stars 17 forks source link

Beginning work on Contribution guidlines #125

Open nathanfletcher opened 2 years ago

nathanfletcher commented 2 years ago

In light of efforts to build a contribution guideline, I'm looking into a number of my favourite open-source projects as a guide.

lacabra commented 2 years ago

@jwflory probably has some very good recommendations and advice, be sure to reach out to him

jwflory commented 2 years ago

Hey! Contributing guidelines are a great next step for the project. It also seems @sabinevidal may have started on this in #115 too.

Generally, the first place I begin with contributing guidelines is thinking through the types of participation you are capable of facilitating and participation you would like to have. Then, you can frame the guidance around that kind of participation with a specific audience in mind for your docs.

Is there existing project documentation I can see to better understand how Kindly is approaching docs at the current moment? Or, is it only the README?

nathanbaleeta commented 2 years ago

Hey! Contributing guidelines are a great next step for the project. It also seems @sabinevidal may have started on this in #115 too.

Generally, the first place I begin with contributing guidelines is thinking through the types of participation you are capable of facilitating and participation you would like to have. Then, you can frame the guidance around that kind of participation with a specific audience in mind for your docs.

Is there existing project documentation I can see to better understand how Kindly is approaching docs at the current moment? Or, is it only the README?

@jwflory please find here existing project documentation for Kindly.

jwflory commented 2 years ago

@nathanbaleeta Super! I didn't realize it was all on Docusaurus. Bonus points for easy management of Markdown source files.

Is there bandwidth with the team to put together a first pass for contributing guidelines? I think it is best if someone more familiar with the project drafts it, but I can definitely weigh in and share feedback on a working draft. If it would help for me to share examples, let me know and I can find some links from other projects.

sabinevidal commented 2 years ago

@jwflory: @nathanfletcher was looking into contribution guidelines! I'm in the process of updating the guidelines with more in-depth info about the project and contributing, especially with the view to simplify and make it easier for new contributors (see #115 ).

jwflory commented 2 years ago

@sabinevidal wrote:

I'm in the process of updating the guidelines with more in-depth info about the project and contributing, especially with the view to simplify and make it easier for new contributors (see #115).

Nice! I see you have a new category and several pieces of new content there. I am guessing there is still some cleaning up happening on the PR. When it is broken up into smaller pieces and you are ready for review, ping me on GitHub or Slack and I am happy to share feedback then. 😀

jwflory commented 2 years ago

@nathanfletcher and I had a chat just now on contributing guidelines and a few other topics in my Open Source Office Hours. Here are some examples of contributing guidelines from other open source projects and communities:

Best practices & advice

These two resources are very helpful. The article gives context for what goes into good contributing guidelines, and the second is a template you can grab and get started with right away:

Highlights from other projects