You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
37 lines
1.9 KiB
37 lines
1.9 KiB
## Contribute
|
|
|
|
CARTO platform is an open-source ecosystem. You can read about the [fundamentals]({{site.fundamental_docs}}/components/) 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. Include your browser, OS and CARTO.js version (it shows up in the browser console).
|
|
4. Specify the steps to reproduce the problem.
|
|
5. Try to add an example showing the problem (using [JSFiddle](http://jsfiddle.net), [JSBin](http://jsbin.com),...).
|
|
|
|
|
|
## Contributing code
|
|
Best part of open source, collaborate in CARTO.js 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 CARTO.js repository.
|
|
2. Create a new branch in your forked repository.
|
|
3. Commit your changes. Add new tests if it is necessary (```grunt test```), remember to follow ["How to build"](https://github.com/CartoDB/carto.js/blob/master/README.md#how-to-build) steps.
|
|
4. Open a pull request.
|
|
5. Any of the CARTO.js mantainers will take a look.
|
|
6. If everything works, it will merged and released \o/.
|
|
|
|
If you want more detailed information, this [GitHub guide](https://guides.github.com/activities/contributing-to-open-source/) is a must.
|
|
|
|
|
|
## Completing documentation
|
|
|
|
CARTO.js documentation is located in ```docs/```. That folder is the content that appears in the [Developer Center](http://carto.com/developer-center/carto-js/).
|
|
Just follow the instructions described in [contributing code](#contributing-code) and after accepting your pull request, we will make it appear online :).
|
|
|
|
## Submitting contributions
|
|
|
|
You will need to sign a Contributor License Agreement (CLA) before making a submission. [Learn more here](https://carto.com/contributions).
|