Contributing

How to contribute to the Digital Public Good for CRVS

The value of open-source products as digital public goods is that an active community of contributors will help to maintain and grow the product.

The Open Source Guides website has a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project. Contributors and people new to open source will find the following guides especially useful:

We need your support to ensure that every individual on the planet is recognised, protected and provided for from birth. In this video we explain our product backlog, how to submit issues and how to contribute code.

Contributing to code

OpenCRVS uses GitHub as its source of truth. The core team will be working directly there. All changes will be public from the beginning. Please review the contributing file, clone the repository and submit a pull request. The authors will review the code and merge it in if all is well. By contributing to the OpenCRVS code, you are conforming to the terms of the license.

Github Discussions

If you need to talk to us at any time regarding technical issues or feature ideas please refer to Github Discussions.

Reporting new issues

We use GitHub Issues if you would like to raise a bug or propose a change or feature. If you just have a general topic of discussion, or would like some technical help, please chat with us on Github Discussions.

Reporting bugs

We use GitHub Issues for our public bugs. If you would like to report a problem, take a look around and see if someone already opened an issue about it, or chat with us on Github Discussions. If you are certain this is a new, unreported bug, you can submit a bug report.

Take screenshots or record your screen. Loom is a great tool you can use to record a video and paste a link to it into your bug. Open a bug report on Github following the guidance.

Reporting security bugs

Make sure to include a detailed description of the bug. Open a bug report on Github following the guidance.

Proposing a change

If you would like to request a new feature or enhancement but are not yet thinking about opening a pull request, you can:

  1. Email us at team@opencrvs.org to explore the feature together.

  2. File an issue with the feature template

  3. Join the community at https://community.opencrvs.org/ and ask what others think about your idea

Last updated