Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

31 lines (21 loc) · 1.42 KB

Contributions are warmly welcome!

You can contribute in many ways:

Report Bugs

Report bugs at https://github.com/SioKCronin/SwarmOpt/issues

If you are reporting a bug, please include:

Your operating system name and version. Any details about your local setup that might be helpful in troubleshooting. Detailed steps to reproduce the bug. Fix Bugs Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it. Those that are tagged with "first-timers-only" is suitable for those getting started in open-source software.

Write Documentation

SwarmOpt could always use more documentation, whether as part of the official docs, in docstrings, or with blog posts, articles, Youtube videos, etc.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/SioKCronin/SwarmOpt/issues

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome!

(These contribution guidelines were adapted from my favorite Github project for exemplary best practices, PySwarms)