docker / kitematic

Visual Docker Container Management on Mac & Windows
https://kitematic.com
Apache License 2.0
12.23k stars 1.41k forks source link

Proposal: Some ideas to improve the open source contribution #282

Open DieterReuter opened 9 years ago

DieterReuter commented 9 years ago

When you're publishing such a great project to the public, one of then main thing every maintainer want to get is: feedback. Feedback, new ideas about improvements, bug fixes, and a lot of really cool features.

Proposals: I'd like to propose some minor changes and enhancements, just to get more and even better feedback.

  1. Use a AUTHORS file (example) to document all the contributors to the project. This is not only for copyright purposes, but everbody who has contributed a PR or an idea will be proud to find his/her name on this list. And maybe you could also use a NICKS list too (example).
  2. Create a new label proposal for proposing new features or architectural changes that needs to be discussed in detail, before you can decide whether to implement and how. I would greatly encourage everybody to use a proposal when the new wanted feature or enhancement isn't part of the current roadmap. And if this is so important or great for lots of users or use case, you can decide to put in on the roadmap earlier that planned.
  3. The ROADMAP.md is really cool, but I think it could be even better, if you define more smaller work items. Then it should be easier to get help from the community. And maybe you could use it together as a check list, to show if a feature or work item is already done. Here is a small example (this contents is just random):

Milestone 1

Milestone 2

I think there are a lot more such small improvements we could define. This is a proposal and should be discussed and is therefor subject of change. Please feel free to improve and to get into more details.

robtec commented 9 years ago

:+1:

seanli commented 9 years ago

Thanks @DieterReuter this is a really good idea :+1:

jmorganca commented 9 years ago

This is fantastic.

  1. Strongly agree. Contributors should be displayed openly. There's probably some sort of script we can use here.
  2. This is key and a great idea. We can add this to CONTRIBUTING.md
  3. +1 I think in general that it's hard for a new contributor to start helping with Kitematic right now. Having direct issues linked to our roadmap as a checklist would help people know what can be worked on that's priority.

Some next steps: