Silver Surfer is Apache 2.0 licensed and accepts contributions via GitHub
pull requests. This document outlines some coding conventions, contact points and other resources to make
it easier to get your contribution accepted.
We gratefully welcome improvements to issues and documentation as well as to code.
By contributing to this project you agree to the Developer Certificate of Origin (DCO). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution. No action from you is required, but it's a good idea to see the DCO file for details before you start contributing code to Devtron.
Please send a GitHub Pull Request to silver-surfer with a clear list of what you've done (read more about pull requests). We can always use more test coverage. Please follow our coding conventions (below).
Always write a clear messages for your commits.
Start reading our code and you'll get the hang of it. We optimize for readability:
- Please always format the code before you create a pull request. Know more about go fmt tool
- Please include test cases covering all the base & corner cases.
- This is open source software. Consider the people who will read your code, and make it look nice for them. It's sort of like driving a car: Perhaps you love drifting when you're alone, but with passengers the goal is to make the ride as smooth as possible.
- Please update the documentation in case of new feature or enhancement.
The project uses discord for communication:
To join the conversation, simply join the discord and use the #contrib channel.