-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
154 additions
and
152 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.