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

Improve contributing guidelines. #1038

Open
tech4him1 opened this issue Jan 22, 2018 · 8 comments
Open

Improve contributing guidelines. #1038

tech4him1 opened this issue Jan 22, 2018 · 8 comments
Labels
area: docs community event: Write the Docs Suggested issues for Writing Day contributors at Write the Docs Portland 2019 kind: discussion pinned roadmap

Comments

@tech4him1
Copy link
Contributor

tech4him1 commented Jan 22, 2018

We need to have a better system to allow new contributors to jump in quickly. We need to have a better system for contributing to this project, as right now we don't have a whole lot of standards in place. We would like to open this up for discussion, if anyone has some suggestions, please feel free to chime in!

cc/ @Benaiah @erquhart @talves
related/ #982

@erquhart
Copy link
Contributor

erquhart commented Jan 22, 2018

Super excited for this!

cc/ @verythorough @phae @neutyp

@phae
Copy link
Contributor

phae commented Jan 22, 2018

A place to start might be gathering any examples out there of other OSS projects that do it well / have inspiring guidelines?

@talves
Copy link
Collaborator

talves commented Jan 23, 2018

I am not sure the focus of getting them in faster to contribute is the whole picture, but is a good start. Making it clearer how to contribute is a core reason someone might hold off on a contribution.

Here is a starter list of where we should probably start:

  • Step by step docs of how to start contributing for all areas (see next)
  • Documents by area to contribute (docs, org site, widgets, core cms app, etc)
  • Structured testing plans for new/existing contributors
  • Contributor retention is a focus that needs to be considered.
  • Issues need to be reviewed, categorized and put into timelines or ratings for urgency in a timely manner by level of experience needed

These are all time consuming tasks. No magic here in my opinion. @phae makes a good point on mirroring what works for others.

Maybe have special contributor roles that are time consuming get benefits from Netlify services like reseller access to the API and/or higher limits and/or access to paid services for free.

@verythorough verythorough changed the title Create contributing guidelines. Improve contributing guidelines. May 6, 2018
@cory-wc
Copy link
Contributor

cory-wc commented Aug 20, 2018

Need to link in general Contributing guide -- Contributing guide for docs is at https://github.com/netlify/netlify-cms/tree/master/website - readme.md

And I'm claiming this!

@erquhart
Copy link
Contributor

Nice @cory-wc!

@verythorough verythorough added the event: Write the Docs Suggested issues for Writing Day contributors at Write the Docs Portland 2019 label May 16, 2019
@jerdog
Copy link
Contributor

jerdog commented May 19, 2019

I'll start putting headings in as a guide for improving this while here at WTD

@jerdog
Copy link
Contributor

jerdog commented May 19, 2019

May not be fully done by end of WTD Writing Day but will submit a PR with where we're at when the day is done.

@stale
Copy link

stale bot commented Oct 29, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs community event: Write the Docs Suggested issues for Writing Day contributors at Write the Docs Portland 2019 kind: discussion pinned roadmap
Projects
None yet
Development

No branches or pull requests

9 participants