Skip to content

Latest commit

 

History

History
25 lines (14 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

25 lines (14 loc) · 1.64 KB

Contributing

We welcome all contributions!

Setup and local development

We recommend you run the platform locally to review your changes before submitting them. Please refer to the instructions in the TECHNICAL-SETUP.md file to set up and run the app in your local environment.

Language and style

Content production in this project follows the general conventions and best practices from the Google developer documentation style guide.

Components and platform features

The platform supports a number of custom components. You can find an overview of all components, and a demonstration of their use, within the /features-test/index.md file - the feature test is also deployed to the live portal.

Additionally, the file features-test/landingpage.md demonstrates the use of the landingpage components, and is also deployed to the live portal.

Pull request

Please submit your contribution with a Pull Request using our default Pull Request template. If you are planning a larger contribution, we recommend you open an Issue first (indicating that you would like to contribute to solve the issue), to allow for further coordination before the submission.

Note

When you submit your Pull Request for review, please make sure to add as much information as possible on the changes implemented through your Pull Request. For example, include what existing files you are updating or creating and with what aim.