Skip to content

Latest commit

 

History

History
60 lines (43 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

60 lines (43 loc) · 2.99 KB
Raw

Contributing

We love new ideas that push this repository and design engagement forward. We are using GitHub issues to track our work on the repository. Here are the ways that you can contribute:

Contribute with Issues

All the open issues are being tracked on the issue page. You can contribute by adding new issues, or solving an existing issue.

Submit a new issue

If you find a mistake, or have questions about the process, you can add a new issue, and one of the design team members will review the issue and respond to it.

Work on an existing issue

  1. You can find the list of open issues here
  2. Enter your thoughts as comments
  3. Assign yourself to the issue if you want to make some changes so that we know someone is working on it
  4. Make changes and submit a Pull Request

Make Changes in Your Branch

You can create a new branch, which is essentially a duplicate of the repo for you, and make changes under your branch. Then submit a pull request, which is a request to merge your branch with the master branch. The design team will review the pull request and decide whether we should merge the branchs or not. Here are the three simple steps:

  1. Create a branch
    • Click on the Branch dropdown
    • Type in a name for the branch: "New Branch"
    • Click on "Create branch: New Branch"
  2. Commit changes
  3. Submit a pull request
    • Click on new pull request button
    • Select "Master" as base (should be default), and your branch as compare
    • Click on create pull request button

Here's a more detailed guide to Pull Requests


Here are some examples of changes you can make in your branch:

Recommend a method

If you have successful experience using a method, and you want to recommend it to our testing process, you can add a new .md file describing your method to the Research Methods folder in your branch. You can then submit a pull request. We would also love to see artifacts produced during the process and we encourage you to share those as well.

The description file should include:

  • Definition and purpose of the method
  • Which phase it belongs to
  • How it works
  • Examples
  • References or resources

Add photos and examples from previous engagements

The more examples that we have the better it will be to spread knowledge and experience of running the sprints. Listed below are steps for adding examples:

  1. In your own branch, edit the README in the folder where you want to add new assets
  2. Add assets that support the explanation of the engagement such as photos, documents, prototypes or videos. Make sure the examples are anonymized.
  3. Add references on the separate phases to the respective parts of the example.
  4. Submit a Pull Request