Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

42 lines (29 loc) · 1.8 KB
Raw

Contributing to ABMS

I love your input! I want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features

Develop with Github

I use github to host code, to track issues and feature requests, as well as accept pull requests.

I Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (use Github Flow). I actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested.
  3. Make sure your code lints.
  4. Issue that pull request!

Any contributions you make will be under the GPL v3 Software License

In short, when you submit code changes, your submissions are understood to be under the same GPLv3 License that covers the project. Feel free to contact if that's a concern.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
  • Be specific!
  • Give sample code if you can.
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People love thorough bug reports. I'm not even kidding.

  • Use a Consistent Coding Style
  • 2 spaces for indentation rather than tabs

License

By contributing, you agree that your contributions will be licensed under its GPL v3 License.