Skip to content

Commit

Permalink
Changed optional deps (0.8a1.dev23)
Browse files Browse the repository at this point in the history
  • Loading branch information
squillero committed Aug 28, 2023
1 parent 9cfc61c commit 5ab8593
Show file tree
Hide file tree
Showing 5 changed files with 154 additions and 152 deletions.
54 changes: 22 additions & 32 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,43 @@
Contribute to Byron
===================

First of all, thank you! :+1:
#### First of all, thank you! :+1:

* [Join the team](#join-the-team)
* Use the tool and [report a success story](#report)
* Fail to use the tool and [submit a bug report](#report)
* [Fix a bug](#coding)
* [Add a brand new feature](#coding)
* [Improve an existing feature](#coding)
* Extend/update/proofread the documentation
* Draw logo/icons
* [~~Donate money~~](#money-donations)
Generally speaking there are several ways to contribute:

### Join the team
##### * Create/Extend/update/proofread the documentation

Please, contact Alberto or Giovanni directly:
Contact Alberto or Giovanni if your English is acceptable and you want to play with documentation generators such as [Sphinx](https://en.wikipedia.org/wiki/Sphinx_(documentation_generator)). Some of these works could even be considered *small dissertations* (tesine) in Politecnico di Torino.

* If you enjoy playing with Python and Evolutionary Computation, and you are looking for a 6-month master thesis. Note: We are **always** looking for valuable students, even when there are no theses posted on the official channels.
* If you have a great idea for an improvement, but you are not sure how to hack it.
* If you feel like doing it.
##### * Add a brand new feature
##### * Improve an existing feature

### Reports
Contact Alberto or Giovanni if you enjoy playing with Python and Evolutionary Computation, and you are looking for a 6-month master thesis. Start sharpening your favorite IDE.

We use [GitHub's issues](https://github.com/cad-polito-it/byron/issues) for bug reporting.
**Note**: We are always looking for valuable students, even when there are no theses posted on the official channels.

If you have published a paper using any version of byron, please let us know.
##### * Use the tool and report a success story

Anyhow, feel free to send us an email describing your story.
Let us know if you have published a paper using any version of byron or MicroGP (Byron's predecessor).

### Coding
**Note**: Byron's official DOI is not available, yet.

#### TL;DR
##### * Fail to use the tool and [submit a bug report](#report)

* The default branch is always the more stable
* Do not clone experimental branches `exp/*` unless you know what you are doing
* Follow this [style guide](https://github.com/squillero/style/blob/master/python.md) and keep the code formatted with [Black](https://black.readthedocs.io/en/stable/)
* Write as few lines of code and as much line of comments as possible (ie. use builtins, exploit generators and list comprehension)
* Use [pytest](https://docs.pytest.org/) and [Coverage.py](https://coverage.readthedocs.io/) for unit testing (ie. `coverage run -m pytest`)
* Use [pylint](https://mypy-lang.org/) for basic linting and [mypy](https://mypy-lang.org/) for additional type checking
* Be [paranoid](./PARANOIA.md) (cit. *"I need someone to show me the things"*)
* It may be wise to contact Alberto or Giovanni
We plan to use [GitHub's issues](https://github.com/cad-polito-it/byron/issues) for bug reporting.

## Money Donations
##### * [Fix a bug](#coding)

Kudos!

##### * Draw logo/icons

Byron is still missing a nice logo.

##### * [~~Donate money~~](#money-donations)

Thanks for trying, but we do not accept monetary donations:

* Alberto and Giovanni are working on Byron as an integral part of their research activities. Therefore, they are already paid by their institutions, namely: *Politecnico di Torino* (Italy); *INRAE — AgroParisTech* (France) and *Institut des Systèmes Complexes de Paris Île-de-France* (France).
* Students have worked, are working, and will work on Byron as part of their academic curricula, either for Master's theses or Ph.D. programs.
* A few volunteers did excellent work on specific topics, but as volunteers they did not ask for payment.

So, why not donating [**time**](#join-the-team) instead of money?
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![License: Apache 2.0](https://img.shields.io/badge/license-apache--2.0-green.svg)](https://opensource.org/licenses/Apache-2.0)
[![Status: Actrive](https://img.shields.io/badge/status-active-brightgreen.svg)](https://github.com/cad-polito-it/byron)
![Language: Python](https://img.shields.io/badge/language-python-blue.svg)
![Version: 0.1.dev2](https://img.shields.io/badge/version-0.8a1.dev19-orange.svg)
![Version: 0.1.dev2](https://img.shields.io/badge/version-0.8a1.dev23-orange.svg)
![Codename: Don Juan](https://img.shields.io/badge/codename-Don_Juan-pink.svg)
[![Documentation Status](https://readthedocs.org/projects/byron/badge/?version=pre-alpha)](https://byron.readthedocs.io/en/pre-alpha/?badge=pre-alpha)

Expand Down
4 changes: 2 additions & 2 deletions byron/global_symbols.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@
from collections import defaultdict
import multiprocessing

__version__ = "0.8a1.dev19"
__date__ = "27-08-2023"
__version__ = "0.8a1.dev23"
__date__ = "28-08-2023"
__codename__ = "Don Juan"
__author__ = "Giovanni Squillero and Alberto Tonda"
__copyright__ = "Copyright (c) 2023 Giovanni Squillero and Alberto Tonda"
Expand Down
Loading

0 comments on commit 5ab8593

Please sign in to comment.