Skip to content
This repository has been archived by the owner on Nov 18, 2024. It is now read-only.

Latest commit

 

History

History
68 lines (45 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

68 lines (45 loc) · 2.6 KB
Raw

Contributing Guidelines

🎉 Thank you for choosing to contribute to the project! 🎉

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct.

How Can I Contribute?

Issues

Create a bug report or feature request by following these steps:

  1. Ensure an issue does not already exist for it by searching here
  2. If creating a bug report, follow all instructions in the bug report template
  3. If creating a feature request, follow all instructions in the feature request template
  4. If creating a user story, follow all instructions in the user story template
  5. For any issue, you must also follow the guidelines as defined in Creating an Issue

Pull Requests

Create a pull request by follwing these steps:

  1. Use the fork and pull workflow to make your pull requests, see here for more information
  2. Follow all instructions in the pull request template
  3. Follow the style guides

Style Guides

Git Commit Messages

  • For larger changes split commit messages into a subject line and a body

    For example:

  $ git commit -m "Subject line, contains a brief summary of the changes
  >
  > The body, describes what has changed and why"
  • One-line messages are appropriate for small changes
  • Use the present tense e.g. ("Add button" not "Added button")
  • Use the imperative mood e.g. ("Move button to..." not "Moves button to...")
  • For more in-depth guidelines (but not required) see here

Coding Conventions

Java

Follow Google Java style guide. The server maven project has been setup to auto-format during the build lifecycle. You can manually reformat by running the following commands:

mvn fmt:format // Reformats Java code
mvn fmt:check  // Check formatting is corret

Javascript

Follow the code style defined by /client/.prettierrc (which is applied on top of the recommended Prettier style). The client project has been configured to auto-format by running Prettier using the 'pre-commit' git hook. You can manually format staged files with the following command:

yarn lint-staged