Skip to content

Commit

Permalink
Add CONTRIBUTING.md (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
zhenghaoz authored Aug 2, 2023
1 parent dd0f343 commit 6bd9d0d
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Contribution Guide

Welcome and thank you for considering contributing to gorse-rs!

Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing these open source projects. In return, we will reciprocate that respect by addressing your issue, assessing changes, and helping you finalize your pull requests.

## Getting Started

### Setup Develop Environment

These following installations are required:

- **Rust**: Install Rust from [rustup.rs](https://rustup.rs/).
- **Docker Compose**: Start a local Gorse cluster for testing.

```bash
docker-compose up -d
```

### Run Unit Tests

```bash
cargo test
```

## Your First Contribution

### Contribution Workflow

To contribute to the Gorse code base, please follow the workflow as defined in this section.

- Fork the repository to your own Github account
- Make commits and add test case if the change fixes a bug or adds new functionality.
- Run tests and make sure all the tests are passed.
- Push your changes to a topic branch in your fork of the repository.
- Submit a pull request.

This is a rough outline of what a contributor's workflow looks like. Thanks for your contributions!

## Getting Help

Join us in the [Discord](https://discord.gg/x6gAtNNkAE) and post your question in the `#developers` channel.

0 comments on commit 6bd9d0d

Please sign in to comment.