Skip to content

Commit

Permalink
Move contributing information to CONTRIBUTING.md (#26)
Browse files Browse the repository at this point in the history
# Description

Simply moved all contributing information in `README.md` to
`CONTRIBUTING.md`

Fixes #11 

## Type of change

Please delete options that are not relevant.

- [x] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] This change requires a documentation update

# Checklist:

- [x] My code follows the style guidelines of this project
- [x] I have performed a self-review of my code
- [x] I have commented my code, particularly in hard-to-understand areas
- [x] I have made corresponding changes to the documentation, if any
- [x] My changes generate no new warnings
- [x] I have performed tests that prove my fix is effective or that my
feature works, if necessary
- [x] New and existing unit tests pass locally with my changes

---------

Co-authored-by: Cole MacPhail <[email protected]>
  • Loading branch information
Ian Tapply and colemacphail authored Nov 12, 2023
1 parent 26c379c commit 2f504d8
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 10 deletions.
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
## Contributing
Want to contribute to this project? We make it as simple as possible to open a pull request and contribute to the codebase to make it the best it can. To open a pull request and contribute code, it's easy! Just follow these steps:

1. Fork the repository and either contribute to the `main` branch on that repository, or make a new branch on that forked repository.
2. Once you have pushed all of the changes to your forked repository, go to [the pull request section](https://github.com/Simbotics/2023-Simbot/pulls) in our repository and click the `new pull request` button on the right side of your screen.
3. When you are on the pull request screen, set the compare branch to the one on your forked repository and set the base branch to be the `main` branch. We also kindly ask that you add a short description of the changes you have to our codebase in the description section of the pull request. Please be sure that you set an appropriate title for your pull request.
4. Finally, once you have reviewed your contributions just hit the `create pull request` button and you're all set!

_Note: Please await the review of one or more repository managers until your code changes are pushed to main._ **ALL GITHUB ACTIONS MUST PASS IN A PULL REQUEST TO BE ELIGIBLE TO BE MERGED**
10 changes: 0 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,6 @@
# Simbot-Base
A base robot with the most up to date utilities and starting components to get started on robot code as fast as possible

## Contributing
Want to contribute to this project? We make it as simple as possible to open a pull request and contribute to the codebase to make it the best it can. To open a pull request and contribute code, it's easy! Just follow these steps:

1. Fork the repository and either contribute to the `main` branch on that repository, or make a new branch on that forked repository.
2. Once you have pushed all of the changes to your forked repository, go to [the pull request section](https://github.com/Simbotics/2023-Simbot/pulls) in our repository and click the `new pull request` button on the right side of your screen.
3. When you are on the pull request screen, set the compare branch to the one on your forked repository and set the base branch to be the `main` branch. We also kindly ask that you add a short description of the changes you have to our codebase in the description section of the pull request. Please be sure that you set an appropriate title for your pull request.
4. Finally, once you have reviewed your contributions just hit the `create pull request` button and you're all set!

_Note: Please await the review of one or more repository managers until your code changes are pushed to main._ **ALL GITHUB ACTIONS MUST PASS IN A PULL REQUEST TO BE ELIGEABLE TO BE MERGED**

## Contributors and Credits
Thank you to the following who has contributed, supplied the tools to make this project even possible, or has supported this project along the way.

Expand Down

0 comments on commit 2f504d8

Please sign in to comment.