Skip to content

Latest commit

 

History

History
72 lines (44 loc) · 5.56 KB

README.md

File metadata and controls

72 lines (44 loc) · 5.56 KB

Contribute content

Thank you for your interest in contributing to the platformOS documentation! Our docs are a tool for our community, so we strive to ensure they serve you well. We always welcome any kind of contribution to our documentation: we value your feedback, and appreciate any improvement suggestions or extensions.

Give us feedback

Create an issue with your finding.

Edit or add topics on the GitHub UI

Go to the file you would like to change, click edit and commit changes on the GitHub UI.

Edit or add topics using git

  1. Fork the repository.
  2. Install dependencies (NPM).
  3. Change something or add a new topic. Please check if a template is already available for the type of content you’d like to contribute. We have prepared templates for most content on our documentation page, to make contribution easier, and to ensure the consistency of contributed content. Please make sure to follow our style guide.
  4. Create a pull request.
  5. We review your changes, and either get back to you with our feedback, or merge your changes.

Contributors

Thank you to all our contributors!

pavelloz diana-lakatos piotrze lemingos Slashek kv109
pavelloz diana-lakatos piotrze lemingos Slashek kv109
godot ignacy chrisdanek DeanmvSG digitalfuel onecreative
godot ignacy chrisdanek DeanmvSG digitalfuel onecreative
kubaugustyn JJBragg juliennearme streflik mjaneczek Agsiegert
kubaugustyn JJBragg juliennearme streflik mjaneczek Agsiegert
Developer-DNM szabosteve
Developer-DNM szabosteve

Contribute code

Required global dependencies

  • nodejs 8.10 and abovee
  • npm 6.1 and above

Development

npm ci # installs local dependencies

npm start # runs webpack in watch mode

Build production assets

npm run build # runs webpack in production mode

End to end local testing

We are using testcafe to run E2E tests

npm install -g testcafe

npm run test-local # uses headless chrome. use `npm run` for details