[DISCUSS] Community documents

[Vladislav Mitov <vl...@miracl.com>]

Hello all,

I'm posting this to initiate a discussion about some surrounding documents
that every community needs. I would like to collect opinions on what kind
of documents we need in the beginning, what should be the place to store
them and what will be the process of agreeing the content of those
documents.

My suggestion.

We need the following documents:

- Code of conduct. I would suggest to take
https://www.djangoproject.com/conduct/ as base, because it is recognized as
one of the best code of conducts in the open source world.

- Contribution guidelines.

- Coding conventions.

- Process of reporting issues, and most importantly reporting security
issues, which shouldn't be public before fixed.

Regarding storing and agreeing upon, I suggest using markdown and storing
them in a repository dedicated for such documents in markdown.


I'm sure I'm missing many important points, that’s why I’m starting this
discussion.

Regards,
Vladi

Re: [DISCUSS] Community documents

[Nick Kew <ni...@apache.org>]

On Thu, 18 Feb 2016 15:24:47 +0200
Vladislav Mitov <vl...@miracl.com> wrote:

> Hello all,
> 
> I'm posting this to initiate a discussion about some surrounding
> documents that every community needs. I would like to collect
> opinions on what kind of documents we need in the beginning, what
> should be the place to store them and what will be the process of
> agreeing the content of those documents.

This is useful stuff to have.  Presumably parts of it can be
based on existing/past practice for the code at github,
though you'll know that better than I.

> My suggestion.
> 
> We need the following documents:
> 
> - Code of conduct. I would suggest to take
> https://www.djangoproject.com/conduct/ as base, because it is
> recognized as one of the best code of conducts in the open source
> world.
> 
> - Contribution guidelines.
> 
> - Coding conventions.
> 
> - Process of reporting issues, and most importantly reporting security
> issues, which shouldn't be public before fixed.

Security issues get discussed and worked through on the private@
mailinglist before going public.  That's regular apache practice,
and will include times when the report is originally sent to
security@apache.org and passed by them to us for action.

One more for the list: workflow, including git workflow.
What level of review requirements to set for commits to master
branch, and will there be other special/reserved branches?
Or do we make master the bleeding edge and adopt a backport/review
process?

> Regarding storing and agreeing upon, I suggest using markdown and
> storing them in a repository dedicated for such documents in markdown.

A wiki area would be the obvious choice for markdown.

> I'm sure I'm missing many important points, that’s why I’m starting
> this discussion.

Thanks for getting the ball rolling on it!

One thing though.  While process is important, it shouldn't stand
in the way of progress.  It would be good to see some actual
development activity on Milagro at Apache!

-- 
Nick Kew