Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build: [master] Release 4.35.1 hotfix #351

Merged
merged 19 commits into from
Sep 22, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ script:
- npm run lint-ci
- npm run build
- npm run test-ci
- npm run test-e2e-ci
# - npm run test-e2e-ci

before_deploy:
# Workaround to run before_deploy only once
Expand Down
211 changes: 211 additions & 0 deletions CHANGELOG.md

Large diffs are not rendered by default.

26 changes: 16 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,30 @@

Welcome to FormSG! The following are guidelines for contribution. Use your best judgment, and feel free to propose changes to this document in an issue.

## How can I contribute?
## Getting started

When contributing to this repository, **please first discuss the change you wish to make via issue**, email, or any other method with the repository owners before making the change.
To contribute, you can start by taking a look at our open issues marked 'contribute' under GitHub's 'Issues' tab. Feel free to assign yourself to any 'contribute' issue that interests you, and comment with questions or clarifications.

## Bug reports and feature requests
Otherwise, please **first discuss the change you wish to make via GitHub issue**, [email](mailto:formsg@tech.gov.sg), or any other method with the repository owners beforehand.

## Security reports

Please do not file an open issue for ongoing security bugs. Instead, email us directly with your findings at [formsg@tech.gov.sg](mailto:formsg@tech.gov.sg).

## Bug reports and feature requests

The following guidelines help 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](https://go.gov.sg/formsg-issues) and [existing or past pull requests](https://go.gov.sg/formsg-pulls).
You might find out that you don't need to create one.
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

- **Use a 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**
Expand All @@ -31,18 +38,17 @@ Issues available to be picked up by the community are labeled with `contribute`.
If you're submitting a pull request, some points to note:

1. Ensure any install or build dependencies are removed before the end of the layer when doing a build. Refer to [README.md](https://go.gov.sg/formsg-readme) for more details
2. Update the [README.md](https://go.gov.sg/formsg-readme) with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
2. Update the [README.md](https://go.gov.sg/formsg-readme) with details of changes to the interface, including new environment variables, exposed ports, useful file locations and container parameters.
<!---Increase the version numbers of the packages in any example files and the [README.md](https://github.com/opengovsg/formsg/blob/master/README.md) to the new version that this Pull Request would represent.--->
3. 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.

## Contributor License Agreement

Code 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](https://go.gov.sg/ogp-cla) to submit one.
Code 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](https://go.gov.sg/ogp-cla) 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](https://www.tech.gov.sg)), you probably don't need to do it again.

## Contact us

Have questions? Feel free out to us [here](formsg@tech.gov.sg).

Have questions? Feel free to reach out to us at [formsg@tech.gov.sg](mailto:formsg@tech.gov.sg).
32 changes: 27 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

- [FormSG](#formsg)
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Local Development (Docker)](#local-development-docker)
- [Prerequisites](#prerequisites)
- [Running Locally](#running-locally)
Expand All @@ -23,6 +24,29 @@
- [Contributing](#contributing)
- [Support](#support)

## Features

FormSG is a form builder application built, open sourced and maintained by the [Open Government Products](https://open.gov.sg) team of the Singapore [Government Technology Agency](https://tech.gov.sg) to digitise paper processes.

Notable features include:

- 19 different form field types, including attachments, tables, email and mobile
- Verified email and mobile phone fields via integrations with Twilio and AWS SES
- Automatic emailing of submissions for forms built with Email Mode
- End-to-end encryption for forms built with Storage Mode
- (Singapore government agencies only) Citizen authentication with [SingPass](https://www.singpass.gov.sg/singpass/common/aboutus)
- (Singapore government agencies only) Corporate authentication with [CorpPass](https://www.corppass.gov.sg/corppass/common/aboutus)
- (Singapore government agencies only) Automatic prefill of verified data with [MyInfo](https://www.singpass.gov.sg/myinfo/common/aboutus)
- (beta) Webhooks functionality via the [FormSG JavaScript SDK](https://github.com/opengovsg/formsg-sdk).

The current product roadmap includes:

- (in progress) Migrating backend code from JavaScript to [TypeScript](https://www.typescriptlang.org/)
- (in progress) Refactoring backend code to use [Domain-driven Design](https://en.wikipedia.org/wiki/Domain-driven_design)
- (in progress) Migrating backend tests from [Jasmine](https://jasmine.github.io/) to [Jest](https://jestjs.io/) and expanding unit vs integration tests
- (yet to start) Support for webhooks attachments
- (yet to start) Frontend rewrite from [AngularJS](https://angularjs.org/) to [React](https://reactjs.org/)

## Local Development (Docker)

### Prerequisites
Expand All @@ -31,16 +55,14 @@ Install [docker and docker-compose](https://docs.docker.com/get-docker/).

### Running Locally

Run
Run the following shell command to build the Docker image from scratch. This will usually take 10 or so minutes.

```bash
npm run dev
```

to build the Docker image from scratch. This will usually take 10 or so minutes.

If there have been no dependency changes in `package.json` or changes in the
root `server.js` file, you can run
`src/server.ts` file, you can run

```bash
docker-compose up
Expand Down Expand Up @@ -165,7 +187,7 @@ forms and configured using the environment variables below.

## Contributing

We welcome contributions to code open sourced by the Government Technology Agency of Singapore. All contributors will be asked to sign a Contributor License Agreement (CLA) in order to ensure that everybody is free to use their contributions.
We welcome all contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas to code open sourced by the Government Technology Agency of Singapore. Contributors should read [CONTRIBUTING.md](CONTRIBUTING.md) and will also be asked to sign a Contributor License Agreement (CLA) in order to ensure that everybody is free to use their contributions.

## Support

Expand Down
Loading