Skip to content

Commit adb7624

Browse files
docs: add how to contribute in github inteface section
1 parent 57a461b commit adb7624

File tree

5 files changed

+30
-10
lines changed

5 files changed

+30
-10
lines changed

Diff for: .gitignore

+16-6
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,32 @@
1-
_build
2-
.vscode
3-
*/.ipynb_checkpoints/*
1+
# Vscode
2+
.vscode/
3+
4+
# Python
45
tmp/
56
.DS_Store
6-
.nox
7-
__pycache__
87
*notes-from-review.md
98
*.idea*
109
# Grammar / syntax checkers
1110
styles/
1211
# Exclude translation .mo files
1312
locales/*/LC_MESSAGES/*.mo
1413

14+
# Exclude Jupyter Notebook checkpoints
15+
.ipynb_checkpoints/
16+
*/.ipynb_checkpoints/*
17+
18+
# Exclude Python bytecode
19+
__pycache__/
20+
21+
# Exclude build directories
22+
_build/
1523

1624
# Exclude virtual environments
1725
venv/
1826
env/
1927
ENV/
2028
.venv/
2129
.ENV/
22-
*/venv/
30+
*/venv/
31+
.nox
32+
*/.nox/

Diff for: CONTRIBUTING.md

+14-4
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,27 @@ You can do this by clicking the "Fork" button in the top right corner of the rep
3737

3838
[Fork and Clone GitHub Repos](https://datascienceskills.org/lessons/git-github/git-intro/3-fork-clone/) is a good resource to learn more about forking.
3939

40-
*__TODO__: This section should show a beginner user how to fork a repository in GitHub.*
41-
4240
## Contributing via the GitHub website
4341

4442
### How to edit a MarkDown file
4543

46-
*__TODO__: This section should show how to use the GitHub interface to edit and previewing a Markdown file.*
44+
The Python Packaging Guide is written in myST, a variant of MarkDown. You can edit the files directly in the GitHub website.
45+
To do so, navigate to the file you want to edit and click the pencil icon in the top right corner of the file.
46+
47+
![Edit file in GitHub](../images/edit-file.png)
48+
49+
To preview your changes, click the "Preview changes" tab.
50+
51+
![Preview changes in GitHub](../images/preview-changes.png)
4752

4853
### How to commit your changes
4954

50-
*__TODO__: This section should show how to commit changes via the GitHub interface.*
55+
When you are done editing the file, scroll down to the bottom of the page. You will see a section called "Commit changes".
56+
Here you can write a title and a description for your changes. Make sure to write a clear and concise title that describes the changes you made.
57+
58+
![Commit changes in GitHub](../images/commit-changes.png)
59+
60+
click on the "propose changes" button to submit your changes and open a pull request. See (How to make a pull request)[#how-to-make-a-pull-request] for more information.
5161

5262
## Contributing locally on your computer
5363

Diff for: images/commit-changes.png

34.8 KB
Loading

Diff for: images/edit-file.png

61 KB
Loading

Diff for: images/preview-changes.png

118 KB
Loading

0 commit comments

Comments
 (0)