Contributing to KubeStellar

Welcome to the KubeStellar Contribution Guide! We are excited to have you here.

You can join the community via our Slack channel.

This section provides information on the Code of Conduct, guidelines, terms, and conditions that define the KubeStellar contribution processes. By contributing, you are enabling the success of KubeStellar users, and that goes a long way to make everyone happier, including you. We welcome individuals who are new to open-source contributions.

There are different ways you can contribute to the KubeStellar development:

• Documentation: Enhance the documentation by fixing typos, enabling semantic clarity, adding links, updating information on changelogs and release versions, and implementing content strategy. Note that the KubeStellar documentation is consolidated into its own repository now.

• Code: Indicate your interest in developing new features, modifying existing features, raising concerns, or fixing bugs.

Before you start contributing, familiarize yourself with our community Code of Conduct.

Visit the GitHub organization and repositories

The KubeStellar GitHub organization is a collection of the different KubeStellar repositories that you can start contributing to.

Sign off your contribution

Ensure that you comply with the rules and policy guiding the repository contribution indicated in the Developer Certificate of Origin (DCO).

If you are contributing via the GitHub web interface, navigate to the Settings section of your forked repository and enable the Require contributors to sign off on web-based commits setting. This will allow you to automatically sign off your commits via GitHub directly, as shown below.

If you are contributing via the command line terminal, run the git commit --signoff --message [commit message] or git commit -s -m [commit message] command when making each commit. For more detailed information about signing and signing off on commits, including steps to create signing keys and use both the -s and -S options, see Sign-off and Signing Contributions.

Contribution Resources

Read the resources to gain a better understanding of the contribution processes.

• Code of Conduct The CNCF code of conduct for the KubeStellar community
• Contributor Ladder Path for becoming a KubeStellar maintainer by contributing
• License The Apache 2.0 license under which KubeStellar is published
• Governance The protocols under which the KubeStellar project is run
• Onboarding The procedures for adding/removing members of our GitHub organization
• Code Contribution Guidelines General Guidelines for contributing to code via our GitHub processes
• Docs/Website
  • Docs Structure Overview of how our website is built with from the source file content and Nextra pagemap
  • Simple Changes How to make quick edit suggestions
  • Version Management Brief summary of the multi-version support
  • Detailed Contribution Guide All the gory details on the site structure and rendering and making more complex changes
    (includes the info in the previous topics)
  • Style Guide Guidelines on writing the prose parts of our documentation/website
• Security
  • Policy Security Policies
  • Contacts Who to contact with security concerns
• Testing How to use the preconfigured tests in the repository
• Packaging How the components of KubeStellar are organized
• Release Process All the steps involved in creating and publishing a new release of KubeStellar
• Release Testing Steps involved in testing a release or release candidate before merging it into the main branch.
• Sign-off and Signing Contributions How to properly configure your commits so they are both signed and “signed off” (and how those terms differ)