Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 2.8 KB

contributing.md

File metadata and controls

46 lines (34 loc) · 2.8 KB
Raw

Contribution Guidelines

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

What and how to Contribute

To contribute to the list, there are a few things that are worth outlining before attempting an edit.

  • Primarily, this is a learning resource, secondly it's a place to find links and places to buy parts so people can get started in building their robots.
  • This is not a builders directory. This isn't a place to list who builds robots, this is primarily to help people get started. This is not a conduit to potentially harass builders.
  • This is not a team directory. Like the above, this is also not a place to list teams. There are facebook pages and websites for that.
  • This is a place to list suppliers and stores. Conversely, this is place to list parts suppliers, even if it's headed by a robot combat team.
  • If you're unsure where to place a link for learning, here's a few tips:
    • If it's a basic tutorial, is not too detailed and is suitable for beginners, consider placing it under 'Robot Combat Basics'.
    • If it deals with a full build of a particular weight category, place the link under 'Building Fighting Robots' under the appropriate weight category.
    • If it's a tip or a tutorial i.e. how to program an ESC or making a component, this belongs in the 'Hacks and Tips' section.
  • If you're not sure about something, please get in touch with the list creator.

If you're going to contribute, the simple way of doing this is (obviously) having a Github account. You can then be able to fork this list and make the necessary changes to the readme.md document.

  • Fork this repository under your own account.
  • When you've made your edits, make a pull request to the original repository.
  • The pull request will then be reviewed.
  • If it adheres to the guidelines, your changes will be put in the original repository.

Ensure your pull request adheres to the following guidelines:

  • Check if your fork is up to date to the original repository.
  • Make sure your links work!
  • Make sure your links are placed under the appropriate sections.
  • Your changes aren't just shoving in a link and that's it, add a small description next to it.
  • List your changes when you make the pull request.

Thank you for your suggestions!

Updating your PR

A lot of times, making a PR adhere to the standards above can be difficult. If the maintainers notice anything that we'd like changed, we'll ask you to edit your PR before we merge it. There's no need to open a new PR, just edit the existing one. If you're not sure how to do that, here is a guide on the different ways you can update your PR so that we can merge it.