Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DCRepublic authored Nov 21, 2024
1 parent c86dc93 commit 3c1ed12
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Contributing

Thanks for considering contributing to Scheduler-V2!

## Opening issues

If you find a bug, please feel free to [open an issue](https://github.com/swat-sccs/scheduler-v2/issues).

If you taking the time to mention a problem, even a seemingly minor one, it is greatly appreciated, and a totally valid contribution to this project. Thank you!

## Fixing bugs

We love pull requests. Here’s a quick guide:

1. [Fork this repository](https://github.com/swat-sccs/scheduler-v2/fork) and then clone it locally:

```bash
git clone --recursive https://github.com/swat-sccs/scheduler-v2.git
```

2. Create a topic branch for your changes:

```bash
git checkout -b fix-for-that-thing
```
3. Commit a failing test for the bug:

```bash
git commit -am "Adds a failing test to demonstrate that thing"
```

4. Commit a fix that makes the test pass:

```bash
git commit -am "Adds a fix for that thing!"
```

6. If everything looks good, push to your fork:

```bash
git push origin fix-for-that-thing
```

7. [Submit a pull request.](https://github.com/swat-sccs/scheduler-v2/pulls)


## Adding new features

Thinking of adding a new feature? Awesome! [open an issue](https://github.com/swat-sccs/scheduler-v2/issues). and let’s work on it together!

0 comments on commit 3c1ed12

Please sign in to comment.