Skip to content

Latest commit

 

History

History
94 lines (61 loc) · 3.42 KB

CONTRIBUTING.md

File metadata and controls

94 lines (61 loc) · 3.42 KB

Contributing to Layer0

This page contains information about reporting issues as well as some tips and guidelines for potential open source contributors. Make sure you read our community guidelines before participating.

If you're interested in hacking on Layer0, please also see our README.md, which details the various components of Layer0.

Our contributor documentation is based largely on the good work at Docker. Thanks to the Docker team for helping to establish a solid OSS community!

Topics

Reporting security issues

Please DO NOT file a public issue, instead send your report(s) privately to [email protected].

Reporting other issues

The easiest way to contribute to Layer0 is to send us a detailed report when you encounter an issue.

Be sure to check that our issue database doesn't already include your problem or suggestion before submitting an issue.

When reporting issues, please include (where applicable):

  • Steps to reproduce the problem
  • The output of l0 admin debug.
  • The output of l0-setup --version
  • Context. What are you trying to do?

Exceptionally long log output should be posted as a gist (https://gist.github.com). Don't forget to remove sensitive data from your logfiles before posting (you can replace those parts with "REDACTED").

Quick contribution tips and guidelines

This section gives the experienced contributor some tips and guidelines.

Pull requests are being accepted 🆒

The maintainers of Layer0 love pull requests. If you make a good one that follows our brief guidelines, you'll be forever immortalized in our commit history.

Conventions

Fork the repository and make changes on your fork in a feature branch:

  • Name your branch XXXX-something where XXXX is the number of the primary issue you're referencing.

Depending on the changes you're proposing, you may need to update the following tests:

Please ensure that all tests are passing.

Update the documentation when creating or modifying features. Test your documentation changes for clarity, concision, and correctness, as well as a clean documentation build via make build.

Pull request descriptions should be as clear as possible and include a reference to all the issues that they address.

Successful changes

  • Make sure that your PR is directly related to an existing issue. If an issue doesn't already exist, make a new one.

  • Keep PRs small and concise. If you must make a large changeset, we can discuss how to proceed in the PRs' associated issue.

Layer0 community guidelines

  • Be respectful. We appreciate courteous and polite community members; snarkiness and soapboxing are highly discouraged. We are all here to make Layer0 better.

  • Don't break the law by posting another company's assets, unlicensed cat gifs, etc.

  • Stay on topic.

Violating the community guidelines will result in being blocked from the QuintilesIMS Github organization.