Skip to content

Latest commit

 

History

History
25 lines (23 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

25 lines (23 loc) · 1.85 KB

Contributing

  1. Fork this repository.
  2. Clone the new repository to your machine by running $ git clone https://github.com/Your-github-handle-here/queersintech.git in your terminal.
  3. Take a ticket tagged help wanted from the issues. If you are interested in an issue that does not have that label, check with the Queers In Tech team by commenting on the issue itself.
  4. Create a topic branch. Branch names should begin with the issue number, followed by text describing the work. Please use lower-kebab-case (i.e. 2-readme-updated).
  5. Complete work that follows the code quality guidelines.
  6. Set the original Queers in Tech repository as your upstream repository by running $ git remote add upstream https://github.com/pporche87/queersintech.git in your terminal.
  7. Resolve merge conflicts and make sure you have up to date code by running $ git rebase upstream/master in your terminal.
  8. Push up your code to your repository.
  9. Make a pull request to the main repository.
  10. If someone on the Queers In Tech team gives you comments for improvement, fix them in a new commit and push up your code.

Set Up Development Environment

  1. After cloning the repository to your machine, run $ npm install in the root directory.
  2. When that is done, $ cd client and $ npm install in the client directory.
  3. Start the development server with $ npm start.

Code Quality Guidelines

  • Write intention revealing code - use well named identifiers for variables, functions, css classes, etc.
  • Functions are small and serve a single purpose
  • Documentation is updated (including the readme, and any API documentation)
  • All tests passing - aiming for 100% test coverage
  • Spaces (2), not tabs
  • No lines may be longer than 80 characters
  • Tests must be written for new features or changes to features.