Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

49 lines (34 loc) · 2.23 KB
Raw

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

Maintenance and Improvements

Submit a new issue

If you find a mistake or have some questions with the repository, please add a new issue.

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. Here's how.

Recommend a method

If you want to recommend a method for our design engagement, you can add a new .md file that describes the method under the folder Methods in your branch and then submit a pull request.

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, examples & case studies 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. Create a topic branch
  2. Edit the README in the folder where you want to add new assets
  3. Add assets that support the explanation of the sprint such as photos, documents, prototypes or videos.
  4. Add references on the separate phases to the respective parts of the example.
  5. Submit a Pull Request.

--

Quick Guide for Pull Requests:

Listed below are steps to submitting a Pull Request in GitHub:

  1. Fork the repository.
  2. Make your changes in a topic branch.
  3. Squash your commits into a single one (more).
  4. Rebase against origin/master, push to your fork and submit a pull request.

More detailed guide on pull request