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

Latest commit

 

History

History
38 lines (24 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

38 lines (24 loc) · 2.06 KB
Raw

Contribute to STACKn

We try to make contributing to our products as easy and transparent as possible and we appreciate your input, whether it's:

  • Reporting a bug
  • Proposing a feature
  • Submitting a fix
  • Discussing the current state

We develop with GitHub

We use github to host our codebase, to track issues and feature requests, as well as accept and merge pull requests.

We actively welcome your pull requests which, we believe, are the best way to propose changes to the codebase!

The branching strategy we follow is GitFlow and we actively follow the guidelines that come with it.

GitHub Issues

Report a bug or propose a feature by opening a new GitHub Issue. We have set up templates accordingly so, choose the one that matches your case. Please try to provide all the required information in the template. If you believe some of the sections are not relevant to your case, you can omit them.

Branches & Pull Requests

  • main branch has the latest release of STACKn
  • develop branch is where we add functionality and submit bugfixes
  • if your branch introduces new functionality, name it feature/[GitHub-Issue-ID]
  • if your branch resolves a bug, name it issue/[GitHub-Issue-ID]
  • if your branch is a hotfix, name it hotfix/[GitHub-Issue-ID]

Open your pull requests against the develop branch unless you're resolving a critical bug in production (hotfix). Then your pull request should be against main branch.

Code checks

We defined GitHub actions that check code quality and formatting against pushed branches and pull requests. We use:

  • autopep8 to conform to the PEP 8 code style
  • isort to organize imports

For more information please refer to the code check action: .github/workflows/studio-code-checks.yaml.