doc: Contribution guide

lahovniktadej · lahovniktadej · commit 362c777e1139 · 2023-12-04T10:37:01.000+01:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,54 @@
+# Contributing to Firefly Algorithm
+:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
+
+## Code of Conduct
+This project and everyone participating in it is governed by the [Firefly Algorithm Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [iztok.fister1@um.si](mailto:iztok.fister1@um.si).
+
+## How Can I Contribute?
+
+### Reporting Bugs
+Before creating bug reports, please check existing issues list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible in the [issue template](.github/templates/ISSUE_TEMPLATE.md).
+
+### Suggesting Enhancements
+
+Open new issue using the [feature request template](.github/templates/FEATURE_REQUEST.md).
+
+### Pull requests
+
+Fill in the [pull request template](.github/templates/PULL_REQUEST.md) and make sure your code is documented.
+
+## Setup development environment
+
+### Requirements
+
+* Poetry: [https://python-poetry.org/docs](https://python-poetry.org/docs)
+
+After installing Poetry and cloning the project from GitHub, you should run the following command from the root of the cloned project:
+
+```sh
+poetry install
+```
+
+All of the project's dependencies should be installed and the project ready for further development. **Note that Poetry creates a separate virtual environment for your project.**
+
+### Dependencies
+
+| Package  | Version | Platform |
+|----------|:-------:|:--------:|
+| numpy    | ^1.26.1 |   All    |
+
+#### Development dependencies
+
+| Package | Version  | Platform |
+|---------|:--------:|:--------:|
+| pytest  | ^7.4.3   |   Any    |
+
+## Development Tasks
+
+### Testing
+
+Manually run the tests:
+
+```sh
+poetry run pytest
+```
