Skip to content

Latest commit

 

History

History
69 lines (56 loc) · 3.77 KB

CONTRIBUTING.md

File metadata and controls

69 lines (56 loc) · 3.77 KB
Raw

Contributing

Thank you for your interest in this project...

Inquiring about an Issue

If you find an issue that interests you, please leave a note asking about it first. If you don't, someone else may, and I will have to accept his or her patch/PR. It's best to leave a note so everyone knows who the patch is assigned to, and won't interfere with the work you want to do.

Communication

Code formatting

Indent of 4 spaces in HTML

Tags

  • tags should be specific
  • Use 10 tags or less, each tag should be less than 40 characters
  • links that discuss many different types of mental health issues should be tagged using keywords that the article focuses on, not with each disorder listed
  • Don't use the tag "mental health". Every link in the KB should be related to "mental health", which makes the tag unnecessary.
  • Don't use synonyms. (ex. "veterans" is good, but don't add military. It's implied. If the links is more broadly about the military, then it's okay to use "military" and "veterans".
  • If you're not sure what tags to use, don't spend any time worrying about it. Ask in the chat room or make a comment when you submit your pull request.

Dates

No longer used, in the process of removing (October 23, 2017)

Note to those with Collaborator access

  • Don't push directly to the remote upstream. Make the changes on your fork and submit a PR.

Pull Requests

  1. Fork the repo (if you haven't already done so)
  2. Clone it to your computer
  3. You're welcome to join the chat room
  4. When you're ready to work on an issue, be sure you're on the master branch. From there, create a separate branch (e.g. issue_32)
  5. Make your changes. If you're unsure of some details while you're making edits, you can discuss them on the ticket or in the chat room.
  6. Commit your changes
  7. If this is your first contribution, add yourself to CONTRIBUTORS.md
    • commit the change
  8. Push the working branch (e.g. issue_32) to your remote fork and make your pull request
    • Do not merge it with the master branch on your fork. That would result in multiple, or unrelated patches being included in a single PR.
  9. If any further changes need to be made, comments will be made on the pull request or I'll @ping you in the chat room.

It's possible to work on two or more different patches (and therefore multiple branches) at one time, but it's recommended that beginners only work on one patch at a time.

Syncing

Periodically, especially before starting a new patch, you'll need the sync your repo with mine (remote upstream). GitHub has instructions for doing this:

  1. Configuring a remote for a fork
  2. Syncing a Fork
    • On that page, it shows how to merge the master branch (steps 4 & 5 of Syncing a Fork).

CSS design (we use Bootstrap)

If you haven't ever used Bootstrap or any CSS framework -