From d6803250e6086727e4b653c98bfc056cf1286a27 Mon Sep 17 00:00:00 2001 From: Simon Date: Fri, 15 May 2015 17:01:39 +0200 Subject: [PATCH] Add checklist items as per #1 --- _posts/2015-04-24-communication.md | 11 +++++++++++ ...ntributing-file.md => 2015-04-24-contributing.md} | 2 ++ _posts/2015-04-24-contributors-file.md | 2 ++ _posts/2015-05-15-bitesize-tasks.markdown | 12 ++++++++++++ _posts/2015-05-15-bug-reporting-guidelines.markdown | 12 ++++++++++++ _posts/2015-05-15-code-of-conduct.markdown | 12 ++++++++++++ _posts/2015-05-15-constructive-criticism.markdown | 12 ++++++++++++ _posts/2015-05-15-documentation.markdown | 12 ++++++++++++ _posts/2015-05-15-examples.markdown | 12 ++++++++++++ _posts/2015-05-15-getting-started.markdown | 11 +++++++++++ ...2015-05-15-keep-an-eye-on-your-community.markdown | 12 ++++++++++++ _posts/2015-05-15-mentored-tasks.markdown | 12 ++++++++++++ _posts/2015-05-15-pair-programming-tasks.markdown | 12 ++++++++++++ .../2015-05-15-show-your-project-is-alive.markdown | 12 ++++++++++++ _posts/2015-05-15-tests.markdown | 12 ++++++++++++ 15 files changed, 158 insertions(+) create mode 100644 _posts/2015-04-24-communication.md rename _posts/{2015-04-24-contributing-file.md => 2015-04-24-contributing.md} (89%) create mode 100644 _posts/2015-05-15-bitesize-tasks.markdown create mode 100644 _posts/2015-05-15-bug-reporting-guidelines.markdown create mode 100644 _posts/2015-05-15-code-of-conduct.markdown create mode 100644 _posts/2015-05-15-constructive-criticism.markdown create mode 100644 _posts/2015-05-15-documentation.markdown create mode 100644 _posts/2015-05-15-examples.markdown create mode 100644 _posts/2015-05-15-getting-started.markdown create mode 100644 _posts/2015-05-15-keep-an-eye-on-your-community.markdown create mode 100644 _posts/2015-05-15-mentored-tasks.markdown create mode 100644 _posts/2015-05-15-pair-programming-tasks.markdown create mode 100644 _posts/2015-05-15-show-your-project-is-alive.markdown create mode 100644 _posts/2015-05-15-tests.markdown diff --git a/_posts/2015-04-24-communication.md b/_posts/2015-04-24-communication.md new file mode 100644 index 0000000..86ea77a --- /dev/null +++ b/_posts/2015-04-24-communication.md @@ -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. diff --git a/_posts/2015-04-24-contributing-file.md b/_posts/2015-04-24-contributing.md similarity index 89% rename from _posts/2015-04-24-contributing-file.md rename to _posts/2015-04-24-contributing.md index f41b840..81a0c72 100644 --- a/_posts/2015-04-24-contributing-file.md +++ b/_posts/2015-04-24-contributing.md @@ -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? diff --git a/_posts/2015-04-24-contributors-file.md b/_posts/2015-04-24-contributors-file.md index 33bbdf7..29911a9 100644 --- a/_posts/2015-04-24-contributors-file.md +++ b/_posts/2015-04-24-contributors-file.md @@ -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. diff --git a/_posts/2015-05-15-bitesize-tasks.markdown b/_posts/2015-05-15-bitesize-tasks.markdown new file mode 100644 index 0000000..66e21b9 --- /dev/null +++ b/_posts/2015-05-15-bitesize-tasks.markdown @@ -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. diff --git a/_posts/2015-05-15-bug-reporting-guidelines.markdown b/_posts/2015-05-15-bug-reporting-guidelines.markdown new file mode 100644 index 0000000..40a5a82 --- /dev/null +++ b/_posts/2015-05-15-bug-reporting-guidelines.markdown @@ -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. diff --git a/_posts/2015-05-15-code-of-conduct.markdown b/_posts/2015-05-15-code-of-conduct.markdown new file mode 100644 index 0000000..edc66af --- /dev/null +++ b/_posts/2015-05-15-code-of-conduct.markdown @@ -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. diff --git a/_posts/2015-05-15-constructive-criticism.markdown b/_posts/2015-05-15-constructive-criticism.markdown new file mode 100644 index 0000000..3f341fb --- /dev/null +++ b/_posts/2015-05-15-constructive-criticism.markdown @@ -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. diff --git a/_posts/2015-05-15-documentation.markdown b/_posts/2015-05-15-documentation.markdown new file mode 100644 index 0000000..7a9b2cd --- /dev/null +++ b/_posts/2015-05-15-documentation.markdown @@ -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? diff --git a/_posts/2015-05-15-examples.markdown b/_posts/2015-05-15-examples.markdown new file mode 100644 index 0000000..2a2e04c --- /dev/null +++ b/_posts/2015-05-15-examples.markdown @@ -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! diff --git a/_posts/2015-05-15-getting-started.markdown b/_posts/2015-05-15-getting-started.markdown new file mode 100644 index 0000000..c30e9c6 --- /dev/null +++ b/_posts/2015-05-15-getting-started.markdown @@ -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? diff --git a/_posts/2015-05-15-keep-an-eye-on-your-community.markdown b/_posts/2015-05-15-keep-an-eye-on-your-community.markdown new file mode 100644 index 0000000..e5d4a0b --- /dev/null +++ b/_posts/2015-05-15-keep-an-eye-on-your-community.markdown @@ -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. diff --git a/_posts/2015-05-15-mentored-tasks.markdown b/_posts/2015-05-15-mentored-tasks.markdown new file mode 100644 index 0000000..47d8bb1 --- /dev/null +++ b/_posts/2015-05-15-mentored-tasks.markdown @@ -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. diff --git a/_posts/2015-05-15-pair-programming-tasks.markdown b/_posts/2015-05-15-pair-programming-tasks.markdown new file mode 100644 index 0000000..ab826a1 --- /dev/null +++ b/_posts/2015-05-15-pair-programming-tasks.markdown @@ -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. diff --git a/_posts/2015-05-15-show-your-project-is-alive.markdown b/_posts/2015-05-15-show-your-project-is-alive.markdown new file mode 100644 index 0000000..fcab17c --- /dev/null +++ b/_posts/2015-05-15-show-your-project-is-alive.markdown @@ -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. diff --git a/_posts/2015-05-15-tests.markdown b/_posts/2015-05-15-tests.markdown new file mode 100644 index 0000000..d507c9b --- /dev/null +++ b/_posts/2015-05-15-tests.markdown @@ -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?