Skip to content

Add Contributing Standards #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 5, 2022
Merged

Add Contributing Standards #25

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7997898
Add CONTRIBUTING.md
nathen418 Sep 5, 2022
0477dc5
Merge branch 'staging' into bugfix/nathen418/add-contributing-standards
schiltz3 Sep 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# CSSC-bot Contributing guidelines

## Developing New Features

First create a new branch with it's base set to the [staging](https://github.com/Antares-Network/CSSC-Bot/tree/staging) branch.
For naming conventions use `feature/GithubUsername/FeatureName`. Example: `feature/nathen418/mongodb-support`
Next when your feature is ready to be merged, submit a pull request to the [staging](https://github.com/Antares-Network/CSSC-Bot/tree/staging) branch.
This will be used to test your changes along side the rest of the code and any other pending new features.

## Fixing Bugs

Do the same as the instructions except when naming your branch use the naming convention: `bugfix/GithubUsername/BugName`. Example: `bugfix/nathen418/fix-api-connection-err`

## Editing/Merging Pull Requests

Only merge pull requests you authored or have been approved by the author to merge.

## Pushing to branches

Only push to branches you have been given permission to push to. This means that you should only commit to branches that have your name in the branch name unless the branch owner has given you permission to push to it.