Skip to content

Commit 27e4f25

Browse files
authored
Merge pull request #1527 from HamedHemati/master
Update Documentation
2 parents faf47a3 + bb8b553 commit 27e4f25

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

Diff for: notebooks/from-zero-to-hero-tutorial/09_contribute-to-avalanche.ipynb

+12-4
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
}
1010
},
1111
"source": [
12-
"---\n",
12+
"]---\n",
1313
"description: How to Contribute Back to the Avalanche Community\n",
1414
"---\n",
1515
"\n",
@@ -43,16 +43,19 @@
4343
"\n",
4444
"**The following rules should be respected:**\n",
4545
"\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",
4747
"* Always pull before pushing a commit.\n",
4848
"* Try to assign to yourself one issue at a time.\n",
4949
"* 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",
5050
"* If you add a new feature, please include also a _test_ and a usage example in your PR.\n",
5151
"\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",
5356
"\n",
57+
"then, **make sure** that the following command returns no test errors:\n",
5458
"```bash\n",
55-
"pycodestyle avalanche tests examples\n",
5659
"python -m unittest discover tests -v\n",
5760
"```\n",
5861
"\n",
@@ -86,6 +89,11 @@
8689
"You can run _this chapter_ and play with it on Google Colaboratory:\n",
8790
"[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/ContinualAI/avalanche/blob/master/notebooks/from-zero-to-hero-tutorial/09_contribute-to-avalanche.ipynb)"
8891
]
92+
},
93+
{
94+
"cell_type": "markdown",
95+
"metadata": {},
96+
"source": []
8997
}
9098
],
9199
"metadata": {

0 commit comments

Comments
 (0)