Skip to content

Commit 0725139

Browse files
committed
Add a first draft for Contributing
1 parent e549b49 commit 0725139

File tree

3 files changed

+52
-9
lines changed

3 files changed

+52
-9
lines changed

Contributing.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Contribution guideline
2+
3+
In any contribution, please be as explicit as possible.
4+
5+
## Bug report
6+
7+
Use our [issue tracker](https://github.com/tpaviot/ProcessScheduler/issues) to report bugs.
8+
9+
A *bug* is either: an unexpected result or an unexpected exception raised by Python. It can't be anything else.
10+
11+
- choose an *explicit title*
12+
13+
- the title is not enough:: *always* insert a short and explicit description of what's going wrong
14+
15+
- the description *must* be followed by the shorted python script that reproduces the issue. The script must be self-contained, i.e. it can just be copied/pasted and be executed, no need for additional imports or tweaks
16+
17+
- use the correct markdown directives to insert the python formatted code.
18+
19+
- set the "bug" label to the issue so that it can quickly be identified as a bug.
20+
21+
## Feature request
22+
23+
Use our [issue tracker](https://github.com/tpaviot/ProcessScheduler/issues) to request new features.
24+
25+
- choose an *explicit title*
26+
27+
- insert a short/long/as you want/ description. Be as explicit as possible. Too general descriptions are difficult to read/understand
28+
29+
- you *may* insert a shot python snippet that demonstrates what you would like to achieve using the library, but you can't currently do.
30+
31+
- set the "enhancement" label to the issue.
32+
33+
## Contribute demos or use cases
34+
35+
You're welcome to contribute new jupyter notebooks.
36+
37+
## Contribute core library code
38+
39+
- follow the naming conventions (see below)
40+
41+
- each commit should be described by a short and explicit commit message
42+
43+
- submit a Pull Request (PR)
44+
45+
46+
## Naming Conventions
47+
48+
- method names follow the ```undersocre_convention```
49+
50+
- class names follow the ```CamelCase``` naming convention
51+
52+
- Tasks constraints names start either by Task or Tasks (with an ending 's). If the constraint target one single tasks, use the first one. If it targets two or more tasks, use the second.

LICENSE renamed to LICENSE.txt

File renamed without changes.

README.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -72,15 +72,6 @@ There are some [Jupypter notebooks](https://github.com/tpaviot/ProcessScheduler/
7272

7373
ProcessScheduler code is unittested, covered (coverage.py, codecov.io), continuously-integrated at MS azure, analyzed (codacy).
7474

75-
## Contibuting
76-
77-
The development started in december 2020, this is a release-early-work-in-progress. Feel free to submit :
78-
* new issues: questions, feature requests etc. Use our [issue tracker](https://github.com/tpaviot/ProcessScheduler/issues). Don't forget to assign the proper issue label, and describe the problem as precisely as possible by adding some python code to illustrate your question.
79-
80-
* new examples: submit a PR to add a notebook to the examples-notebooks suite
81-
* new tests: submit a PR to improve the number/type of current unittests
82-
* new code: submit a PR for fixing bugs, add new Task or Resource, opitmize function etc. Before submission, use pylint to remove trailing whitespaces, unused variables, unused imports
83-
8475
## License/Author
8576

8677
ProcessScheduler is distributed under the terms of the GNU General Public License v3 or (at your option) any later version.

0 commit comments

Comments
 (0)