Skip to content

Latest commit

 

History

History
67 lines (45 loc) · 2.91 KB

CONTRIBUTING.md

File metadata and controls

67 lines (45 loc) · 2.91 KB
Raw

Contributing to the Galadriel Project

The change management process for the Galadriel Project is designed to be transparent, fair, and efficient. Anyone may contribute to a project in the Galadriel repository that they have read access to, provided they:

Getting started

  • First, README to become familiar with how the Galadriel Project is managed.
  • Make sure you're familiar with our Coding Conventions.

Sending a pull request

  1. Fork the repo
  2. Commit changes to your fork
  3. Update the docs, if necessary
  4. Ensure your branch is based on the latest commit in main
  5. Ensure all tests pass (see project docs for more information)
  6. Make sure your commit messages contain a Signed-off-by: <your-email-address> line (see git-commit --signoff) to certify the DCO
  7. Make sure your all your commits are GPG-signed
  8. Open a pull request against the upstream main branch

All changes to Galadriel project must be code reviewed in a pull request (this goes for everyone, even those who have merge rights).

After your pull request is submitted

Pull requests are approved according to the process described in our governance policies. At least one maintainer must approve the pull request.

Once your pull request is submitted, it's your responsibility to:

  • Respond to reviewer's feedback
  • Keep it merge-ready at all times until it has been approved and actually merged

Following approval, the pull request will be merged by the submitter of the pull request.

Coding Conventions

Coding conventions will follow the SPIFFE project conventions.

Datastore Contributions

For more detailed information on working with the Datastore, including structure, migrations, schema changes, and more, please review the Datastore README.

Third-party code

When third-party code must be included, all licenses must be preserved. This includes modified third-party code and excerpts, as well.

Repositories and Licenses

All repositories under this project should include:

  • A detailed README.md which includes a link back to this file
  • A LICENSE file with the Apache 2.0 license
  • A CODEOWNERS file listing the maintainers

All code projects should use the Apache License version 2.0, and all documentation repositories should use the Creative Commons License version 4.0.