Skip to content

Latest commit

 

History

History
109 lines (72 loc) · 3.34 KB

CONTRIBUTING.md

File metadata and controls

109 lines (72 loc) · 3.34 KB
Raw

Contributing to NiaPy

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

Code of Conduct

This project and everyone participating in it is governed by the NiaPy Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

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. Fill out the required template, the information it asks for helps us resolve issues faster.

Suggesting Enhancements

  • Open new issue
  • Write in details what enhancement would you like to see in the future
  • If you have technical knowledge, propose solution on how to implement enhancement

Pull requests

If you are not so familiar with Git or/and GitHub, we suggest you take a look at our beginner's guide.

  • Fill in the required template
  • Document new code
  • Make sure all the code goes through Flake8 without problems (run make check command)
  • Make sure PR builds goes through

Setup development environment

Requirements

Development dependencies

NiaPy dependencies:

Package Version Platform
numpy ^1.26.1 All
pandas ^2.1.1 All
openpyxl ^3.1.2 All
matplotlib ^3.8.0 All

Test dependencies:

Package Version Platform
pytest >=7.4.2,<9.0.0 Any
pytest-cov ^4.1.0 Any
pytest-randomly ^3.15.0 Any

Documentation dependencies (optional):

Package Version Platform
sphinx ^7.2.6 Any
sphinx-rtd-theme ^1.3.0 Any

Installation

Install project dependencies into a virtual environment:

$ poetry install

Install the optional documentation dependencies with:

$ poetry install --with docs

To enter created virtual environment with all installed dependencies run:

$ poetry shell

Development Tasks

Testing

Run the tests:

$ poetry run pytest

Documentation

Build the documentation:

$ poetry shell
$ cd docs
$ make html

Support

Usage Questions

If you have questions about how to use Niapy, or have an issue that isn’t related to a bug, you can place a question on StackOverflow.

You can also join us at our Slack Channel or seek support via email

NiaPy is a community supported package, nobody is paid to develop package nor to handle NiaPy support.

All people answering your questions are doing it with their own time, so please be kind and provide as much information as possible.