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.

Sign up for GitHub

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

Jump to bottom

Greater clarity for available features, project roadmap and deployment instructions; disable E2E tests #301

Merged

liangyuanruo merged 20 commits into develop from contributing

Sep 9, 2020

Contributor

liangyuanruo commented Sep 8, 2020 •

edited

Loading

Problem

FormSG is available as open source to the community, but questions remain on the available features, product roadmap and deployment instructions.

Solution

List the available features and provide clarity on the product/engineering roadmap
Provide clear instructions on how to start contributing based on GitHub issues listed
Provide an email to report security issues
Clarify that the project team welcomes "all contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas"
Clarify the infrastructure required to run the application in a cloud environment

These are modest improvements; more work is probably required for another project team to get the system deployed

Note: end-to-end tests have been disabled due to a probable concurrency bug. An example is shown here.

liangyuanruo requested review from arshadali172 and r00dgirl

September 8, 2020 09:49

liangyuanruo changed the title ~~Provide greater clarity to project roadmap and system deployment instructions~~ Provide greater clarity to available features, project roadmap and deployment instructions

mantariksh reviewed

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

mantariksh reviewed

View reviewed changes

docs/DEPLOYMENT_SETUP.md Outdated Show resolved Hide resolved

mantariksh reviewed

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

mantariksh reviewed

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

mantariksh reviewed

View reviewed changes

README.md Outdated Show resolved Hide resolved

mantariksh reviewed

View reviewed changes

README.md Outdated Show resolved Hide resolved

mantariksh reviewed

View reviewed changes

README.md Outdated Show resolved Hide resolved

liangyuanruo force-pushed the contributing branch from 4a9df35 to f0fdeec Compare

September 8, 2020 10:37

liangyuanruo commented

View reviewed changes

README.md Outdated Show resolved Hide resolved

arshadali172 suggested changes

View reviewed changes

docs/DEPLOYMENT_SETUP.md Outdated Show resolved Hide resolved

docs/DEPLOYMENT_SETUP.md Outdated Show resolved Hide resolved

docs/DEPLOYMENT_SETUP.md Outdated Show resolved Hide resolved

docs/DEPLOYMENT_SETUP.md Outdated Show resolved Hide resolved

docs/DEPLOYMENT_SETUP.md Show resolved Hide resolved

r00dgirl approved these changes

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

liangyuanruo and others added 16 commits

September 8, 2020 19:44


          fix(readme): mailto syntax

6d6fd7a


          doc(contributing): instructions for security findings; minor touchups

37fb793


          doc(readme): instructions and clarifications on scope of contributions

7b7d1ad


          doc(readme): refactor running locally statement

1b792ec


          doc(readme): clarify product roadmap

1d6938f


          doc(readme): include corppass

0be4750


          doc(deployment): organise infrastructure employed, markdown linting

86fea26


          doc: Update CONTRIBUTING.md

1150e68

Co-authored-by: Antariksh Mahajan <antarikshmahajan@gmail.com>


          doc: Update CONTRIBUTING.md

f39536a

Co-authored-by: Antariksh Mahajan <antarikshmahajan@gmail.com>


          doc: Update CONTRIBUTING.md

644c00c

Co-authored-by: Antariksh Mahajan <antarikshmahajan@gmail.com>


          doc: Update README.md

db00fa8

Co-authored-by: Antariksh Mahajan <antarikshmahajan@gmail.com>


          doc: Update docs/DEPLOYMENT_SETUP.md grammar

9ca3303

Co-authored-by: Antariksh Mahajan <antarikshmahajan@gmail.com>


          doc: apply suggestions from code review

8bc21b3

* file rename to src/server.ts
* hyperlinks to aboutus pages for SP/CP/MyInfo

Co-authored-by: Antariksh Mahajan <antarikshmahajan@gmail.com>


          doc: clarify SMS deployment

ebb63d9


          doc(deployment): default NODE_ENV is production

f878b4c


          doc(deployment): clarify SESSION_SECRET variable

c7c5c0d

liangyuanruo and others added 2 commits

September 8, 2020 19:44


          doc(attachments): add ATTACHMENT_S3_BUCKET in deployment setup instru…

63cf888

…ctions


          Apply Sonjia's suggestions from code review

3be6bc3

Co-authored-by: syan-syan <55272802+syan-syan@users.noreply.github.com>

liangyuanruo force-pushed the contributing branch from 93784b3 to 3be6bc3 Compare

September 8, 2020 11:44

arshadali172 reviewed

View reviewed changes

docs/DEPLOYMENT_SETUP.md Show resolved Hide resolved

arshadali172 reviewed

View reviewed changes

docs/DEPLOYMENT_SETUP.md Outdated Show resolved Hide resolved

liangyuanruo added 2 commits

September 8, 2020 21:30


          docs: remove duplicate LOGO_S3_BUCKET

ccfb1f0


          refactor(e2e)!: disable end-to-end tests

03ea238

E2E tests are disabled due to apparent race condition when evaluating
webhooks in Travis. Link to example:

https://travis-ci.com/github/opengovsg/FormSG/builds/183369046

liangyuanruo changed the title ~~Provide greater clarity to available features, project roadmap and deployment instructions~~ Provide greater clarity to available features, project roadmap and deployment instructions; disable E2E tests

liangyuanruo changed the title ~~Provide greater clarity to available features, project roadmap and deployment instructions; disable E2E tests~~ Greater clarity for available features, project roadmap and deployment instructions; disable E2E tests

liangyuanruo mentioned this pull request

Bug with webhook end-to-end tests #302

Closed

arshadali172 approved these changes

View reviewed changes

liangyuanruo merged commit 8f3c872 into develop

liangyuanruo deleted the contributing branch

September 9, 2020 02:41

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment