Thank you for contributing!
To make everybody's contributions combine into the Voltron of CartoDB builds, here are some guidelines we think will streamline the development process. (Meta sideline--if you've got improvements to these guidelines, absolutely put up a pull request!)
Be respectful. Everyone is doing their best. (TODO: Replace this with a genuine, actionable CoC.)
That's awesome! Your best bet is to... (TODO: Add links to FAQs, message board, etc., once they exist.)
For the moment, please file an issue with the question label.
File an issue with the help wanted label!
That's also awesome! Good job. To let us know about it most helpfully, you should:
- Check the following resources, just in case you've found a known issue:
- The repository issues queue
- TODO: Add further resources.
- Make sure you've got enough information to really file a solid report, including:
- The simplest possible replication conditions
- A clear set of state information about your install (like your
.envfile contents, your Docker engine version, etc.) - A description of the expected behavior, and how your deploy is deviating from it
- Format that stuff up into an issue, and label it with
bug!
TODO: Provide more specifics about issue formatting, required state info, etc.
Sweet. If you can file a PR (with a clear description of what you've updated) that's wonderful, but if you just want to file an issue labeled enhancement, that's helpful as well. This absolutely includes documentation--if you feel there's something worth clarifying, clarify away.
TODO: Add guidelines for:
- Finding candidates for first contributions
- Structuring a PR
- Documenting the contents/effects of a PR
- Getting feedback on a PR
- Testing a PR
TODO: Add style guides for:
- Repo layout
- Dockerfiles
- Version tagging
- Documentation