Skip to content
This repository has been archived by the owner on Feb 8, 2024. It is now read-only.

Latest commit

 

History

History
100 lines (65 loc) · 6.77 KB

CONTRIBUTING.md

File metadata and controls

100 lines (65 loc) · 6.77 KB

Contribute to the CORTX Project

CORTX is about building the world's best scalable mass-capacity object storage system. If you’re interested in what we’re building and intrigued by hard challenges, here's everything you need to know about contributing to the project and how to get started.

This guide is intended to provide quick start instructions for developers who want to build, test, and contribute to the CORTX software running on Kubernetes.

After reading this guide, you'll be able to pick up topics and issues to contribute, submit your code, and how to turn your pull request into a successful contribution. And if you have any suggestions on how we can improve this guide, or anything else in the project, we want to hear from you!

Code of Conduct

Thanks for joining us and we're glad to have you. We take community very seriously and we are committed to creating a community built on respectful interactions and inclusivity as documented in our Contributor Covenant Code of Conduct.

You can report instances of abusive, harassing, or otherwise unacceptable behavior by contacting the project team at [email protected].

Deployment and Testing

  • Learn various methods to acquire, build, run and test CORTX on Kubernetes in the Quick Start Guides section of our README.

Repository Overview

Branches

  • main: The primary branch for the repository. This branch will be the source for all cortx-k8s releases and is managed only by the Maintainers of the repository.
  • integration: This branch does the bulk of the heavy lifting for the cortx-k8s project, as it is the target for all Pull Requests - both internal to the repository and external from forked repositories. Maintainers of the repository merge from integration to main to control the release flow of the repository.
  • cortx-test: An internal development-focused branch to stage breaking changes, while allowing the larger community to test CORTX in motion.
  • CORTX-12345...: Branches with the format of CORTX-12345 are feature branches that are actively being worked upon by contributors and will eventually be PR'ed into integration once complete. Due to historical changes in tooling, feature branches may also begin with EOS or UDX as well.

Contribution Process

Prerequisites

The following prerequisites are all available in the root CORTX repository:

Submitting a PR

This compact flow for submitting a Pull Request to the cortx-k8s repository will help ensure that it is able to be accepted and merged with minimal overhead or editing.

⚠️ The target branch of your Pull Request should be the default integration branch

  1. Setup your work environment, starting from the initial repository

    • Fork the repository to another personal or organization account on GitHub.
    • Clone the forked repository locally.
    • git remote add upstream https://github.com/Seagate/cortx-k8s

  2. Create a work branch starting from the default integration branch.

    • git checkout -b my_work_branch integration

  3. Do your work, including writing code, writing tests, updating documentation, and passing all tests locally.

    • Edit files...
    • git add ...
    • git commit -s -m "My commit message" # commit with sign-off

  4. Create a pull request from your my_work_branch against the upstream integration branch.

    • git push origin my_work_branch
    • Submit Pull Request from GitHub with this repository's integration branch as the target branch.
    • Reference: Creating a pull request

  5. Make updates based on code reviews (if needed)

    • Edit files
    • git add ...
    • git commit -s -m "My updated commit message" # commit with sign-off
    • git push origin my_work_branch

  6. Rebasing the work branch for changes that take longer (if needed)

    • git checkout integration
    • git pull upstream
    • git checkout my_work_branch
    • git rebase integration
    • git push origin my_work_branch
    • NOTE: This is usually only required when changes have been delivered to the upstream/integration branch since you created your working branch

  7. Your PR will be reviewed, inspected, and (if appropriate) automatically tested using integrated CI/CD workflows. Once complete, project maintainers will accept the PR and merge the code changes into the integration branch.

  8. Congratulations! You have now successfully contributed to making the CORTX project even better!

Additional Resources

Communication Channels

Please refer to the Support section in the root CORTX repository to learn more about the various channels by which you can reach out to us.

Maintainers

Active and past maintainers of the cortx-k8s project are tracked via the MAINTAINERS.md page. Please use this page for further discussion, communication, and questions as needed while working with CORTX on Kubernetes.

Acknowledgements

After making a contribution, please don't forget to include yourself in our Contributors list in the root CORTX repository!

Thank You!

We thank you for stopping by to check out the CORTX Community. We are fully dedicated to our mission to build open source technologies that help the world save unlimited data and solve challenging data problems. Join our mission to help reinvent a data-driven world.