Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 3.04 KB

CONTRIBUTING.md

File metadata and controls

42 lines (26 loc) · 3.04 KB
Raw

Contributing to GoGovSG

The following is a set of guidelines for contributing GoGovSG. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in an issue.

Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project. Head over here to submit one.

You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project owned by GovTech), you probably don't need to do it again.

How can I contribute?

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

This section guides you through submitting a bug reports or feature requests for GoGovSG. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Before submitting bug reports or feature request, please check existing or past issues and existing or past pull requests. You might find out that you don't need to create one.

When submitting a bug report, please include as many details as possible, such as the steps to reproduce this bug, expected and actual behaviour.

When submitting a feature request, please include the motivation, alternatives that you've considered and any additional contexts that could help us better understand your goal.

Here are some tips to writing good issues:

  • Use clear and descriptive title to identify the problem
  • Describe the exact steps to reproduce the problem and explain how you did it
  • Provide specific examples to demonstrate the steps
  • Include screenshots or animated GIFs if you can
  • Explain why this new feature would be useful

Pull Request Process

If you're submitting a pull request, some things to take note:

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build. Refer to README.md for more details
  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  1. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Have questions? You can also reach out to us here.