-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #27 from joey-kilgore/contributing
Create CONTRIBUTING.md
- Loading branch information
Showing
1 changed file
with
17 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Contributing | ||
This project utilizes the Github ecosystem for managing, tracking, and continuous-integration. | ||
|
||
## Issues | ||
Issues should be submitted using the [Issues page](https://github.com/joey-kilgore/SimLogger/issues), utilizing the templates when relevant (for bugs and feature requests) but use the [Discussions](https://github.com/joey-kilgore/SimLogger/discussions) section for general questions. | ||
|
||
Issues are then marked with relevant tags. First time contributors should look for issues marked [good first issue](https://github.com/joey-kilgore/SimLogger/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) as good starting points. | ||
|
||
## Pull Requests | ||
All pull requests need to be filed using the [Pull requests page](https://github.com/joey-kilgore/SimLogger/pulls) | ||
|
||
## Workflow | ||
1. Issues should first be filed using the [Issues page](https://github.com/joey-kilgore/SimLogger/issues) | ||
2. Developers should fork the repo and work on a branch of that fork. | ||
3. File a pull request on the [Pull requests page](https://github.com/joey-kilgore/SimLogger/pulls) | ||
4. Pull requests must pass all checks (see the [github actions run here](https://github.com/joey-kilgore/SimLogger/tree/main/.github/workflows) | ||
5. Once passed, and checked by the project lead ([joey-kilgore](https://github.com/joey-kilgore)) changes will be merged into main |