|
9 | 9 | }
|
10 | 10 | },
|
11 | 11 | "source": [
|
12 |
| - "---\n", |
| 12 | + "]---\n", |
13 | 13 | "description: How to Contribute Back to the Avalanche Community\n",
|
14 | 14 | "---\n",
|
15 | 15 | "\n",
|
|
43 | 43 | "\n",
|
44 | 44 | "**The following rules should be respected:**\n",
|
45 | 45 | "\n",
|
46 |
| - "* Use PEP8 coding style and work within the 80 columns limit.\n", |
| 46 | + "* Use [*Black*](https://github.com/psf/black) code formatting for a consistent coding style, which also handles line lengths (the 88 columns limit) automatically.\n", |
47 | 47 | "* Always pull before pushing a commit.\n",
|
48 | 48 | "* Try to assign to yourself one issue at a time.\n",
|
49 | 49 | "* Try closing an issue **within roughly 7 days**. If you are not able to do that, please break it down into multiple ones you can tackle more easily, or you can always remove your assignment to the issue!\n",
|
50 | 50 | "* If you add a new feature, please include also a _test_ and a usage example in your PR.\n",
|
51 | 51 | "\n",
|
52 |
| - "Also, before making your PR **make sure** that the following commands return without any errors:\n", |
| 52 | + "Also, before making your PR, first run the following command for code formatting with *Black*:\n", |
| 53 | + "``` bash\n", |
| 54 | + "black .\n", |
| 55 | + "```\n", |
53 | 56 | "\n",
|
| 57 | + "then, **make sure** that the following command returns no test errors:\n", |
54 | 58 | "```bash\n",
|
55 |
| - "pycodestyle avalanche tests examples\n", |
56 | 59 | "python -m unittest discover tests -v\n",
|
57 | 60 | "```\n",
|
58 | 61 | "\n",
|
|
86 | 89 | "You can run _this chapter_ and play with it on Google Colaboratory:\n",
|
87 | 90 | "[](https://colab.research.google.com/github/ContinualAI/avalanche/blob/master/notebooks/from-zero-to-hero-tutorial/09_contribute-to-avalanche.ipynb)"
|
88 | 91 | ]
|
| 92 | + }, |
| 93 | + { |
| 94 | + "cell_type": "markdown", |
| 95 | + "metadata": {}, |
| 96 | + "source": [] |
89 | 97 | }
|
90 | 98 | ],
|
91 | 99 | "metadata": {
|
|
0 commit comments