Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 2.41 KB

CONTRIBUTING.md

File metadata and controls

34 lines (22 loc) · 2.41 KB
Raw

Welcome

You have stumbled upon a top secret part of the internet where rocket scientists hang out.

It would be a multi-national security concern if you joined a Discord channel where the rocket scientists answer any questions thrown their way.

Of course we are kidding, Space Cloud welcomes you!

How to Contribute to Space Cloud? (General Guidelines)

There are multiple ways to contribute to Space Cloud:

  • Code contributions.

  • Creating well-described issues with reproducible steps.

  • Community contributions (making examples, tutorials, spreading the word, or sending out this tweet).

  • Contributing to discussions and offering your views and feedback on community calls.

  • Every PR should be attached to an issue. If your contribution doesn't align with an existing issue, create a new issue and link it with your PR.

  • Space Cloud's motivation and design goals are the driving factors for feature ideas.

If you are confused about where to start, which issue to pick or how to solve one, we welcome your questions in the #contributions channel on Discord.

Sign the CLA

Before your PRs can be merged, you need to sign the Contributor License Agreement.

Project Structure

  • The core components of Space Cloud are gateway, runner and space-cli.
  • The codebase is a monorepo consisting of the core components and their sub modules.

Branching Strategy and Guidelines

  • Space Cloud follows a version and release based branching practice. Active development happens on the version branches starting with the prefix v.
  • For creating a PR, you should create a fork from the latest version branch. Avoid creating forks from master because a version release might force you to rebase your commits.