Skip to content

Contribution Guidelines

Jump to bottom
Clayton Lan edited this page Mar 25, 2020 · 11 revisions

Contributing to SE701 Assignment 1

We want to make contributing to this project as simple and transparent as possible.

Development Process

We use GitHub to host and maintain our codebase. We also use GitHub to track issues, feature requests and manage pull requests.

Pull Requests

Your contributions are welcome!

  1. Fork the repo and create your branch from master. You may want to disable GitHub actions for your fork.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Issue your pull request.

Merging Process

Once a pull request is issued, the code needs to pass the automatic tests and build setup with the CI/CD Pipeline. pull requests must be reviewed and approved by at least one other users before it can be merged. Any feedback or suggestions should be considered and/or added to the code, if they are relevant and appropriate. Once any requested changes are addressed and approved, the reviewer should be the one to merge the code into the master branch.

Any contributions you make will be under the MIT Software License

When you submit code changes, your contributions are to be under the same MIT License that covers the project. Please contact the course coordinator if you have any concerns.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue.

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Give sample code if you can.
  • What you expected would happen
  • What actually happens
  • Any other notes

Coding Style

Please use a consistent coding style.

To ensure that a coding standard is followed, a linter has been set up to check for coding style issues. This is used so that coding style is consistent across all parts of the project. The project is set up to NOT compile or build if the code does not adhere to the style standard that has been set by the linter.

  • You can run npm run lint to run the linter and show you any formatting error and quality issues in the code
  • npm start and npm run build will also check for the same thing, but will also attempt to build the project
  • Finally, you can run npm run lint-fix to automatically fix any of the errors that the linter picks up*.

*Note: Some errors detected by the linter may not be automatically fixed and may require the developer to fix it manually

License

By contributing, you agree that your contributions will be licensed under its MIT License.

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft

Clone this wiki locally