Skip to content

Latest commit

 

History

History
53 lines (32 loc) · 1.69 KB

CONTRIBUTION.md

File metadata and controls

53 lines (32 loc) · 1.69 KB
Raw

Contributing to SMU-Shortcuts

We want to make this project as easy and transparent as possible, whether it's

  • Reporting a bug

  • Submitting a fix

  • Proposing new features

In addition, for SMU students who are not developers, there is Google Forms to do the same thing.

Developing with Github

We used Github to host code, track issues and feature requests, as well as accept pull requests.

Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We welcome your pull requests:

  1. Fork the repo and create your branch from master
  2. Make sure your code lints
  3. Issue that pull request

MIT Software License

When you submit your code, your submissions will be under the same MIT License that covers the project.

Report bugs using Github Issues

We used Github issues to track public bugs Report a new bug by opening a new issue.

Writing a Bug Report

Good Bug Reports tend to have:

  • A quick summary/background of the issue
  • Steps to reproduce
    • Be specific
    • Give sample code if you can
    • Your Operating System
    • Your browser
  • What are your expected results
  • What actually happens
  • Notes (e.g. Why you think this is happening, stuff you tried but did not work)

Having a detailed bug reports help us replicate the issue on our side.

Use a consistent coding style

License

By contributing, you agree that your contributions will be under the MIT License owned by Foldaway.