Skip to content

Latest commit

 

History

History
76 lines (58 loc) · 3.01 KB

CONTRIBUTING.md

File metadata and controls

76 lines (58 loc) · 3.01 KB
Raw

How to Contribute to ThoughtSwap

Thank you for your interest in ThoughtSwap! We welcome any help to make the core project better. As a contributor, following these guidelines will greatly increase the likelihood of your contributions making it into the project:

Submitting Issues

If you would like to submit an issue, please submit it to the core repository.

But before you submit an issue, please search the existing issues to see if what you want to submit already exists, or has already been discussed.

Bugs

Before attempting to fix a bug, we need to reproduce and confirm it. To facilitate this, please provide the following information in bug issues:

  • The url of page the bug occurred on
  • Your browser and its version
  • Your operating system
  • As accurate as possible description of the bug (can include screenshots)

Features

Feel free to request a new feature by simply submitting an issue. If you would like to implement a new feature, please outline a proposal in your issue so your fellow collaborators can discuss its possible utility. (No one wants to do work that won't be appreciated!) Good proposals might discuss:

  • The problem being addressed
  • Your rationale why its important
  • A proposed solution
  • Any context surrounding the issue
  • Any pros and/or cons

Code Guidelines

After following the instructions from the README on getting started you can contribute like a pro by:

  • Working on a proper branch
    • For example a new feature would be at home on git checkout -b feature/my-new-feature
  • Writing Good Commits
    • Generally, the first line is a short overview of your change followed by a blank line, then a longer explanation of changes, and finally, any closing tags separated by a blank line if appropriate. For example: 
      implemented separate login pages

split up the single login page into a dedicated facilitator login page and
a dedicated participant login page. Added a button linking to each in
home.html

closes #XX
  • Following the Angular Style Guide
  • Ensuring your contributions are tested
    • You can write your own tests in /test or run existing tests with npm test

Contribution Submissions

After carrying out your new addition to the project which follows the code guidelines a smooth submission flow should follow under the pull request process. For a full explanation of this process, check out the video tutorial or the official documentation.