CONTRIBUTING.md

Contribute to data.webuild.sg

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

general

1. Fork this project and install the packages with npm i

• Create a new feature/patch branch
• Code code code
• Run npm test to check all linting and tests are passing
• Write a good commit message in the format <type>(<scope>): <subject>
• Pull request using the new feature/patch branch
• Ensure the Travis build passes

add another graph

1. all required data in *.json format are in the data folder

• write code to create a json data that will plot the graph in the folder graphs
• you can use the common utility function in folder tasks/utils.js to create the graph
• ensure you write this json data in a file under the folder public/data so that the frontend can query it
• run npm run build to create this data in folder public/data/*.json
• add the frontend script to create eh graph with d3js in folder public/js
• add the link to the scripts in views/index.pug
• amend the view file to display the graph in file views/index.pug
• run npm start to view the website with the graph

OPEN Open source project

This project is an OPEN Open source project.

Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.

Rules

There are a few basic ground-rules for contributors:

1. No --force pushes or modifying the Git history in any way.
2. Non-master branches ought to be used for ongoing work.
3. External API changes and significant modifications ought to be subject to an internal pull-request to solicit feedback from other contributors.
4. Internal pull-requests to solicit feedback are encouraged for any other non-trivial contribution but left to the discretion of the contributor.
5. Contributors should attempt to adhere to the prevailing code-style.