Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bestfw committed Sep 18, 2023
1 parent 4b57ab2 commit f727c31
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion open-machine-learning-jupyter-book/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -322,4 +322,19 @@ To resolve this issue, you can follow these steps:
3. Ensure that the heading level increases continuously without skipping any levels.
4. If you find a non-continuous heading level increase, adjust it to a continuous level increase.
5. Save the file and re-run the code to ensure the error has been resolved.
```
6. Take care of '---', this will be recognize as a title. If you are transforming md file to ipynb file, and confirm that the above situation does not exist, please delete the last '---'.
```
**Can't run the code locally**
You may encounter a situation where the code cannot be run locally. You can try uploading the document to [Google Colab](https://colab.google/) for running, and then download the file containing the results to submit a PR locally.
**Couldn't find cache key**
You may meet a error like this:
```
ERROR: Execution Failed: /home/runner/work/machine-learning/machine-learning/open-machine-learning-jupyter-book/data-science/data-visualization/visualization-distributions.md
ERROR: Couldn't find cache key for notebook file data-science/data-visualization/visualization-distributions.md. Outputs will not be inserted.
```
To solve this error, you can find the file and just add a ' ' in anywhere of the file, just to resubmit it. And then delete the ' ' in next commit to make sure the file not exist in you PR.

0 comments on commit f727c31

Please sign in to comment.