This repository has been archived by the owner on May 8, 2021. It is now read-only.
forked from uxchecklist/uxchecklist.github.io
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
15 changed files
with
158 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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? |