Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 2.62 KB

CONTRIBUTING.md

File metadata and controls

48 lines (35 loc) · 2.62 KB
Raw

Contribution Guide

Contributions encouraged

I'd love to hear from you! If you have a question, bug report, feature request or a pull request, please reach out.

How to reach out

The preferred way at the moment is to open issues on the Github Issue Tracker

If you want to contribute improvements to the LambdaCD codebase, open a pull request.

How to open the perfect issue

  • Be specific and as detailed as you feel is necessary to understand the topic
  • Provide context (what were you trying to achive, what were you expecting, ...)
  • Code samples and logs can be really helpful. Consider Gists or links to other Github repos for larger pieces.
  • If the UI behaves in a strange way, have a look at your browsers development tools. The console and network traffic might give you some insight that's valuable for a bug report.
  • If you are reporting a bug, add steps to reproduce it.

How to create the perfect pull request

  • Have a look into the README for details on how to work with the code
  • Follow the usual best practices for pull requests:
    • use a branch,
    • make sure you have pulled changes from upstream so that your change is easy to merge
    • follow the conventions in the code
    • keep a tidy commit history that speaks for itself, consider squashing commits where appropriate
  • Run all the tests: ./go test
  • Add tests where possible (UI changes might be very hard to test for limited benefit so I'm more relaxed there)
  • Add an entry in CHANGELOG.md if you add new features, fix bugs or otherwise change LambdaCD in a way that you want users to be aware of. The entry goes into the section for the next release (which is the version number indicated in project.clj), usually the top one. If that section doesn't exist yet, add it.

Contributing new features

If you are building a new feature, consider if this needs to go into the core of LambdaCD. Lots of features (like support for another version control system, reusable build steps, nicer syntactic sugar, a different user interface and many others) can easily be maintained as a separate library. Have a look at lambdacd-artifacts or lambdacd-cctray as an example. If in doubt, open an issue and ask.

Contributing Documentation

The main hub for documentation on LambdaCD is in the wiki. It's writable for everyone so if you have something that's worth knowing for everybody, don't hesitate to add it!