Skip to main content

Contributing

We're happy that you're reading this! We'd love this digital participation platform to be a place to which everyone can contribute.

Do you need changes to the current version of the platform to make it fit your specific needs or local context? You've come to the right place!

Code contributions#

Did you customize your locally deployed code? And do you believe your changes can be of value to the wider community? You can submit them as Pull Request, after which we will consider adding them to the shared codebase.

Do you want some feedback before submitting? Go to the Discussions page, and start a new discussion within the 'Show and tell' category. We will get back to you.

Testing#

TO ADD: How to add tests for the new code

Submitting changes#

Please send a GitHub Pull Request to CitizenLab. Split your work in 1 commit per feature that you've added or edited. Always write a clear log message for your commits that look like this:

$ git commit -m "A brief summary of the commit

A paragraph describing what changed and its impact."

Coding conventions#

TO ADD: Our coding conventions

Contributing translations#

The CitizenLab platform is currently available in the following languages:

  • English
  • Danish()
  • Dutch
  • French
  • German()
  • Norwegian()
  • Polish
  • Portuguese
  • Romanian()
  • Spanish

() = only the public facing parts of the platform are available in this language. The administrative interface (where you manage and configure participation projects, etc.) has not been translated.

You can contribute translations in three ways:

  1. Translate the platform into additional languages
  2. Sign up as a proofreader to review and approve new translations
  3. Suggest improvements to existing copy and translations (typos, style, etc.)

Please contact julienne@citizenlab.co if you would like to contribute.

Product ideas#

Do you have an idea for a feature to add to the platform? Or do you have feedback on how to improve an existing feature? Go to the Discussions page, and if there isn't a thread on it yet, start a new discussion within the 'Ideas' category. We keep track of what happens there, and will be happy to inform you about what can or will be done with your feedback.