Skip to content
This repository has been archived by the owner on May 8, 2021. It is now read-only.

Commit

Permalink
Add checklist items as per #1
Browse files Browse the repository at this point in the history
  • Loading branch information
simonv3 committed May 15, 2015
1 parent 6f7e116 commit d680325
Show file tree
Hide file tree
Showing 15 changed files with 158 additions and 0 deletions.
11 changes: 11 additions & 0 deletions _posts/2015-04-24-communication.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
layout: checklist
title: Communicating with the team
category: Community
example:
example_title:
read_more:
read_more_title:
---

How can someone quickly ask your team a question? Where do they go? IRC? Slack? Hipchat? Twitter? Make sure there's an open communication channel, preferable with real time responses.
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: Contributing.MD
category: Contributing
example: https://github.com/owncloud/core/blob/master/CONTRIBUTING.md
example_title: OwnCloud
read_more:
read_more_title:
---

Do you have a contribute.md file that details how new contributors can lend a hand?
2 changes: 2 additions & 0 deletions _posts/2015-04-24-contributors-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: Contibutor.MD
category: Contributors
example: https://github.com/maxogden/dat/blob/master/contributors.md
example_title: Dat Project
read_more:
read_more_title:
---

Make it easy on future contributors by creating a Contributors.md file and listing the people new contributors should reach out to.
Expand Down
12 changes: 12 additions & 0 deletions _posts/2015-05-15-bitesize-tasks.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: checklist
date: 2015-05-15-16-07
title: "Bitesize Tasks"
category: Getting Started
example:
example_title:
read_more:
read_more_title:
---

Think about adding bitesize tasks to you project that might be easy for new contributors to pick up and fix. Simple things like "fix link on page y" will prove a great entry point for people on your project.
12 changes: 12 additions & 0 deletions _posts/2015-05-15-bug-reporting-guidelines.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: checklist
date: 2015-05-15-16-05
title: "Bug reporting guidelines"
category: Getting Started
example:
example_title:
read_more:
read_more_title:
---

If you want people to report bugs on your project (and you should!) you should tell them what kind of bug reports you want. This will also encourage more thorough reports.
12 changes: 12 additions & 0 deletions _posts/2015-05-15-code-of-conduct.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: checklist
date: 2015-05-15-16-06
title: "Code of Conduct"
category: Community
example:
example_title:
read_more:
read_more_title:
---

A great way to tell newcomers you care about them and their thoughts is to outline what kind of behaviour is okay in your community.
12 changes: 12 additions & 0 deletions _posts/2015-05-15-constructive-criticism.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: checklist
date: 2015-05-15-16-08
title: "Constructive Feedback"
category: Ongoing
example:
example_title:
read_more:
read_more_title:
---

When someone submits a bug or a PR, provide constructive feedback.
12 changes: 12 additions & 0 deletions _posts/2015-05-15-documentation.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: checklist
date: 2015-05-15-15-57
title: "Documentation"
category: "Using"
example:
example_title:
read_more:
read_more_title:
---

How do people use your project? Do you have the most basic documentation in place? Have you commented your code or project files?
12 changes: 12 additions & 0 deletions _posts/2015-05-15-examples.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: checklist
date: 2015-05-15-16-06
title: "Examples"
category: Examples
example:
example_title:
read_more:
read_more_title:
---

Provide examples of your project for people to use. If your project has a web aspect - link to it!
11 changes: 11 additions & 0 deletions _posts/2015-05-15-getting-started.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
layout: checklist
title: Getting Started
category: "Getting Started"
example:
example_title:
read_more:
read_more_title:
---

How do new users get started using your project? What about contributing to your project?
12 changes: 12 additions & 0 deletions _posts/2015-05-15-keep-an-eye-on-your-community.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: checklist
date: 2015-05-15-16-07
title: "Keep an eye on your community"
category: Ongoing
example:
example_title:
read_more:
read_more_title:
---

Remember that your community probably expands beyond your repository and website. Occasionally look at questions being asked on Stack Overflow or on IRC.
12 changes: 12 additions & 0 deletions _posts/2015-05-15-mentored-tasks.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: checklist
date: 2015-05-15-16-07
title: "Mentored Tasks"
category: Getting Started
example:
example_title:
read_more:
read_more_title:
---

Mark some tasks as mentored, indicating that a newcomer can tackle them, and that there will be someone available to help them out with any help they might have.
12 changes: 12 additions & 0 deletions _posts/2015-05-15-pair-programming-tasks.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: checklist
date: 2015-05-15-16-07
title: "Pair Programming Tasks"
category: Getting Started
example:
example_title:
read_more:
read_more_title:
---

Mark some tasks or issues as pair programming tasks. This means that when someone tackles it, they'll have an other person next to them to give them feedback and thoughts.
12 changes: 12 additions & 0 deletions _posts/2015-05-15-show-your-project-is-alive.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: checklist
date: 2015-05-15-16-08
title: "Show your project is alive"
category: Ongoing
example:
example_title:
read_more:
read_more_title:
---

Keep your project alive with updates. You can do this via a blog, a twitter handle, or any other creative way you can think of.
12 changes: 12 additions & 0 deletions _posts/2015-05-15-tests.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: checklist
date: 2015-05-15-16-05
title: "Tests"
category: Getting Started
example:
example_title:
read_more:
read_more_title:
---

A great way for a user to confirm that the program will work on their computer is for them to be able to run the tests that you built for it. You have tests, right? How do they run them?

0 comments on commit d680325

Please sign in to comment.