Skip to content

Commit 362c777

Browse files
committed
doc: Contribution guide
1 parent c44467e commit 362c777

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

CONTRIBUTING.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Contributing to Firefly Algorithm
2+
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
3+
4+
## Code of Conduct
5+
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 [[email protected]](mailto:[email protected]).
6+
7+
## How Can I Contribute?
8+
9+
### Reporting Bugs
10+
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).
11+
12+
### Suggesting Enhancements
13+
14+
Open new issue using the [feature request template](.github/templates/FEATURE_REQUEST.md).
15+
16+
### Pull requests
17+
18+
Fill in the [pull request template](.github/templates/PULL_REQUEST.md) and make sure your code is documented.
19+
20+
## Setup development environment
21+
22+
### Requirements
23+
24+
* Poetry: [https://python-poetry.org/docs](https://python-poetry.org/docs)
25+
26+
After installing Poetry and cloning the project from GitHub, you should run the following command from the root of the cloned project:
27+
28+
```sh
29+
poetry install
30+
```
31+
32+
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.**
33+
34+
### Dependencies
35+
36+
| Package | Version | Platform |
37+
|----------|:-------:|:--------:|
38+
| numpy | ^1.26.1 | All |
39+
40+
#### Development dependencies
41+
42+
| Package | Version | Platform |
43+
|---------|:--------:|:--------:|
44+
| pytest | ^7.4.3 | Any |
45+
46+
## Development Tasks
47+
48+
### Testing
49+
50+
Manually run the tests:
51+
52+
```sh
53+
poetry run pytest
54+
```

0 commit comments

Comments
 (0)