Skip to content

Latest commit

 

History

History
42 lines (30 loc) · 2.55 KB

CONTRIBUTING.md

File metadata and controls

42 lines (30 loc) · 2.55 KB

How to contribute

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.

Learn how things work

  1. Introduction to the data model
  2. Introduction to the storage model
  3. Understanding the codebase
  4. Read the coding standards.

Setup your development environment

  1. Fork the repo.

  2. Clone your forked version of concourse.git.

     $ git clone [email protected]:<username>/concourse.git
    
  3. Follow the instructions on the Concourse Dev Setup guide.

Pick an issue

  1. Choose an open issue or implement a new feature from the roadmap. You can also suggest your own projects.
  2. Create an account in Jira.
  3. If necessary, create a new ticket to track your work. Otherwise, assign an existing ticket to yourself.

Build your changes

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.

Submit your changes

  1. Send a pull request.
  2. Update the Jira ticket with the commit hashes for your change.

Join the team

Shoot us an email if you want to become a regular contributor and help with strategic planning!

Report Issues

If you run into any issues, have questions or want to request new features, please create a ticket in Jira.

Ask Questions

Ping us at [email protected] if you ever have any questions. We're happy to help.