Skip to content

Latest commit

 

History

History
79 lines (59 loc) · 3.69 KB

CONTRIBUTING.md

File metadata and controls

79 lines (59 loc) · 3.69 KB
Raw

The Paketo Buildpacks organization welcomes contributions from everyone. Formally, contributions are given as pull requests for a given repository. To contribute to a repository, follow the steps below:

How do I contribute?

  1. Fork the repo you'd like to make a contribution to
  2. Clone your fork to your local workstation
  3. Create a new branch for the issue
  4. Make the necessary changes on that branch
  5. Commit and push to that branch
  6. Make a pull request against the repo
  7. Sign the Contributor Licensing Agreement, if necessary

Where can I look for issues?

We tag issues that should be reasonable for a new contributor to take on with a good first issue label so you have somewhere to start.

We also have a help wanted label for more general opportunities for members of the community to contribute.

Where can I reach out to the team?

  • Want to report concerns/bugs? Create an issue on the affected repo.
  • Usage issues/help? Reach out to us on Slack.
  • Want to participate in deeper architectural discussions? Attend our weekly working group meetings.

I've been contributing for a while. How do I join the Paketo Buildpacks organization?

The Paketo organization is divided into teams that are responsible for the maintenance of some subset of repositories belonging to a particular domain (e.g. Node.js, Python, Golang).

For each team, there are two tiers of participants:

  • Contributors
  • Maintainers

How do I become a contributor?

Becoming a contributor requires a history of interaction with repositories under a given team's jurisdiction (e.g. node-engine repo for the Node.js team).

Once this history has been established, you may self-nominate or be nominated by an existing contributor or maintainer. Each new contributor must be elected by a super-majority of the team maintainers.

One way to self-nominate is by creating an issue on the language-family repo for a given team. You can find an example of a self-nomination issue on the Ruby buildpack repository. This nomination included links to contributions made as justification for nomination and was approved by a super-majority of the team maintainers.

In order to contribute, you will need to complete CFF Contributor License Agreement.

Start the authorization process by clicking here and selecting the "Cloud Foundry - Series LLCs" option. If you are contributing code as an employee of a company click "Corporate", select the appropriate company from the list, then confirm your affiliation on the page that appears. If you are contributing as an individual, click "Individual". For further assistance with EasyCLA, please submit a support request ticket. The linux-foundation-easycla bot will automatically check if you are covered under the CLA when you make a contribution.

The agreement documents that are signed during the above process can be found on the Paketo website: Corportate CLA Individual CLA

How do I become a maintainer?

New maintainers must already be contributors, must be nominated by an existing maintainer, and must be elected by a supermajority of the steering committee.