Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
90 lines (51 loc) · 3.12 KB

CONTRIBUTING.md

File metadata and controls

90 lines (51 loc) · 3.12 KB

How to contribute to Source Cooperative

Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

  • If possible, use the relevant bug report templates to create the issue.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Features

Prior to implementing a feature, it is recommended to create an issue on GitHub and describe the new feature or change you would like to add.

General Communication

Ask any question about how to use Source Cooperative in the source-cooperative slack channel.

Contributing Code

To make contributions to this codebase, please create a pull request of a feature branch to the main branch. The PR title should conform to Conventional Commits.

Tip

The CHANGELOG.md and the project version within Cargo.toml are managed automatically within our CICD pipeline. There is typically no need for individual developers to alter these values.

Releases

Releases are automated via the Release Please action. As contributions are made to main, a release PR will be kept up-to-date to represent the upcoming release. When that PR is merged, a new Github Release will be generated.

Deployments

Merges to the main branch trigger deployment to the development instance of the proxy.

New releases trigger deployment to the production instance of the proxy.

Manual Deployment Steps

⚠️ Manual deployment should only be necessary in extreme circumstances. Automated deployments via GitHub Workflows are preferred. ⚠️

Deployment

Before you begin the deployment process, ensure that you have the SOURCE_KEY environment variable set with the production key.

Tagging Release

After committing your changes, tag the release and bump the version with the following command:

./scripts/tag-release.sh

Building and Pushing Image

To build and push the docker image to ECR, run the following command:

./scripts/build-push.sh

Deploying to ECS

To deploy the image to ECS, run the following command:

./scripts/deploy.sh

Rolling Back a Deployment

To roll back a deployment, first checkout the code for the version that you want to roll back to. For example:

git checkout v0.1.12

Next, deploy the version to ECS:

./scripts/deploy.sh