Skip to content

Latest commit

 

History

History
34 lines (29 loc) · 3.59 KB

CONTRIBUTING.md

File metadata and controls

34 lines (29 loc) · 3.59 KB
Raw

Contributing

We would love your help! See the projects tab above for open to-do items that need some attention.

Try the current version of the app here.

Prerequisites

Prepare for contributing by following these beginner-friendly steps.

  1. First, sign up here. As a Nonprofit organization, we need this from volunteers.
  2. Make sure you have created a GitHub account, and are signed in.
  3. Reach out to one of Techtonica's admin and send us your username so we can add you as a contributor.
  4. Fork this repo by clicking the "fork" button in the upper-right corner of this page.
  5. Choose a directory on your machine where you plan to store Github Projects. Open your terminal and cd to that directory.
  6. Clone the project by running git clone https://github.com/<your-username-here>/keyboard-shortcuts-practice.git in your terminal, replacing <your-username-here> with your account name. (Learn more about Fork, Clone and Remote.)
  7. Run cd keyboard-shortcuts-practice to get into the root directory.
  8. Run git pull to make sure you have the latest changes.
  9. Run git checkout backend to go to the backend feature branch. This is the only branch that we will be working in.
  10. Follow the steps to run the project locally.
  11. Run git remote add upstream https://github.com/Techtonica/keyboard-shortcuts-practice.git. This is so that you can refer to the original project owned by Techtonica as the upstream version.
  12. Run git remote -v to test that you can get updates from Techtonica's repo. You should see something like this. If it shows an error that you don't have permission, contact a Tectonica admin. You can still get started without this part, but you'll need it soon.

Get started

  1. Choose an issue in the "To Do" column of this board.
  2. Leave a comment that you would like to pick up the issue.
  3. Read the description, and make sure to ask questions about anything that is unclear.
  4. Start on your forked repo's backend branch with git checkout backend.
  5. Make sure you have the latest version of the project with git pull upstream backend or git merge upstream/backend.
  6. Create a new branch with git checkout -b <new-branch-name>. The name should be short and describe the topic you're working in. For example, if its about adding a GET request for unser data, your command could be git checkout -b add-user-get-request.
  7. Make and commit your changes on this new branch, and make a PR when you're ready. Here are some directions on the process.
  8. When creating your PR, be sure to make your pull request to the backend feature branch: making a pull request to the backend branch
  9. See your pull requests here: https://github.com/Techtonica/keyboard-shortcuts-practice/pulls
  10. In your new PR's description, add Fixes #<issue number>, for example fixes #1. This will automatically close the issue once your PR is merged, and it will link the issue with your PR. Also add a description of what the PR is, and how reviewers can validate it.