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

Create contribution guidelines #19

Closed
NMontanaBrown opened this issue Jun 14, 2020 · 5 comments
Closed

Create contribution guidelines #19

NMontanaBrown opened this issue Jun 14, 2020 · 5 comments
Assignees
Labels
docs Issue related to documentation (reStructredText, Markdown, docstrings) help wanted Extra attention is needed

Comments

@NMontanaBrown
Copy link
Member

No description provided.

@NMontanaBrown NMontanaBrown added the docs Issue related to documentation (reStructredText, Markdown, docstrings) label Jun 14, 2020
@NMontanaBrown NMontanaBrown self-assigned this Jun 14, 2020
@NMontanaBrown
Copy link
Member Author

@NMontanaBrown
Copy link
Member Author

Ok, the basic docs needed to set up are now set up, several questions/ a more thorough review should be done addressing the following (probably not the whole gist of what needs review but what I can come up with):
*

  1. Should we merge contributing.md with readme.md?
  2. Reviewing of code of conduct needs to be done by (main) maintainers/community/group/???, we should establish a channel of communication to address potential violations/issues (CoC has some gaps that need filling basically)
  3. Expectations for how quickly issues/requests/comments will be addressed by maintainers should go somewhere (readme or contributions)?
  4. Agree with issue Listing the scope of the code in the main README #6, maybe a vision file is warranted where we outline things that are going to be addressed/worked on/maintained versus less important things? It will help prioritise what issues to work on or delegate.

@NMontanaBrown
Copy link
Member Author

@YipengHu @mathpluscode

@NMontanaBrown
Copy link
Member Author

Interesting links re other code of conduct for inspo: https://www.djangoproject.com/conduct/enforcement-manual/
and generally useful reading/guides from opensource.guide such as: https://opensource.guide/leadership-and-governance/

@YipengHu
Copy link
Member

1 - i prefer the readme is a one-screen information sheet, add a link?
2 - should we establish a core dev team - those will respond to request and given a bit more credit? i'm really not experienced in this, but can try to facilitate if no one else (at least all the names in current repo should be asked)
3 - we can give an estimate only, add a link to wiki?
4 - sure
Just my initial response, open for discussion

s-sd pushed a commit that referenced this issue Jul 2, 2020
s-sd pushed a commit that referenced this issue Jul 2, 2020
s-sd pushed a commit that referenced this issue Jul 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issue related to documentation (reStructredText, Markdown, docstrings) help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants