We welcome constructive contributions from everyone, regardless of skill level. Look over this guide for basic information. If you have questions or need additional guidance, send us an email or a private message.
To get started, please sign the Contributor License Agreement and join the mailing list so you can participate in our conversations about planning, etc.
- Introduction to the data model
- Introduction to the storage model
- Understanding the codebase
- Read the coding standards.
-
Fork the repo.
-
Clone your forked version of concourse.git.
$ git clone [email protected]:<username>/concourse.git
-
Follow the instructions on the Concourse Dev Setup guide.
- Choose an open issue or implement a new feature from the roadmap. You can also suggest your own projects.
- Create an account in Jira.
- If necessary, create a new ticket to track your work. Otherwise, assign an existing ticket to yourself.
Always check that Concourse builds properly after you've made changes. We use Gradle as the build system.
$ ./gradlew clean build installer
If all goes well, run the installer in concourse-server/build/distributions
, launch CaSH and sanity check some smoke tests.
- Send a pull request.
- Update the Jira ticket with the commit hashes for your change.
Shoot us an email if you want to become a regular contributor and help with strategic planning!
If you run into any issues, have questions or want to request new features, please create a ticket in Jira.
Ping us at [email protected] if you ever have any questions. We're happy to help.