Skip to content

Latest commit

 

History

History
55 lines (35 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

55 lines (35 loc) · 2.46 KB
Raw

Contributing

Guidelines on how to contribute to KubeSlice

There are a number of ways you can contribute to the KubeSlice project. We would like to accept your patches and contributions to the KubeSlice code base. This document provides guidelines on how to contribute to the KubeSlice code base. We require all participants to adhere to the Code of Conduct.

Here are some ways to contribute:

  • Contribute to the KubeSlice codebase.
  • Report and triage bugs.
  • Answer questions on KubeSlice discussions forums.
  • Write technical documentation and blog posts, for users and contributors.
  • File Issues.
  • Provide feedback on the codebase and documentation.
  • Submit PRs for small bug fixes.

Contributor Compliance with Developer Certificate Of Origin (DCO)

We require every contributor to certify that they are legally permitted to contribute to our project. A contributor expresses this by consciously signing their commits, and by this act expressing that they comply with the Developer Certificate Of Origin

A signed commit is a commit where the commit message contains the following content:

Signed-off-by: John Doe <[email protected]>

This can be done by adding --signoff to your git command line

Code of Conduct

Please make sure to read and observe our Code of Conduct.

Contributor Workflow

Pull Requests are welcome. In general, we follow the "fork-and-pull" Git workflow that has the following steps:

  1. Fork the repo on GitHub.
  2. Clone the project to your own machine.
  3. Commit changes to your own branch.
  4. Push your work back up to your fork.
  5. Submit a Pull request so that we can review your changes.

NOTE: Be sure to merge the latest from upstream before making a pull request!

Filing Issues

If you encounter a bug, please file an issue in the Github repository. Please provide as much information as possible to help fix the issue. Please file the issue under the appropriate repo.

Coding Guidelines

Developer Guide

This guide helps you to get started with developing kubeslice.

License

Apache License 2.0