observatory-extension/docs/v1/support/02-contribute.md

Contribute

CARTO platform is an open-source ecosystem. You can read about the fundamentals of CARTO architecture and its components. We are more than happy to receive your contributions to the code and the documentation as well.

Filling a ticket

If you want to open a new issue in our repository, please follow these instructions:

1. Descriptive title.
2. Write a good description, it always helps.
3. Specify the steps to reproduce the problem.
4. Try to add an example showing the problem.

Contributing code

Best part of open source, collaborate in Data Observatory code!. We like hearing from you, so if you have any bug fixed, or a new feature ready to be merged, those are the steps you should follow:

1. Fork the repository.
2. Create a new branch in your forked repository.
3. Commit your changes. Add new tests if it is necessary.
4. Open a pull request.
5. Any of the maintainers will take a look.
6. If everything works, it will merged and released \o/.

If you want more detailed information, this GitHub guide is a must.

Completing documentation

Data Observatory documentation is located in docs/. That folder is the content that appears in the Developer Center. Just follow the instructions described in contributing code and after accepting your pull request, we will make it appear online :).

Tip: A convenient, easy way of proposing changes in documentation is by using the GitHub editor directly on the web. You can easily create a branch with your changes and make a PR from there.

Submitting contributions

You will need to sign a Contributor License Agreement (CLA) before making a submission. Learn more here.