Skip to content

Commit 677b126

Browse files
committed
MAINT: Rm duplicated contributing info from README.
1 parent 05b892a commit 677b126

File tree

1 file changed

+0
-135
lines changed

1 file changed

+0
-135
lines changed

README.md

Lines changed: 0 additions & 135 deletions
Original file line numberDiff line numberDiff line change
@@ -25,141 +25,6 @@ or navigate to any of the documents listed below and download it individually.
2525
8. [Tutorial: Plotting Fractals](content/tutorial-plotting-fractals.ipynb)
2626
9. [Tutorial: Analysing the impact of the lockdown on air quality in Delhi, India](content/tutorial-air-quality-analysis.md)
2727

28-
29-
## Contributing
30-
31-
We very much welcome contributions! If you have an idea or proposal for a new
32-
tutorial, please [open an issue](https://github.com/numpy/numpy-tutorials/issues)
33-
with an outline.
34-
35-
Don’t worry if English is not your first language, or if you can only come up
36-
with a rough draft. Open source is a community effort. Do your best – we’ll help
37-
fix issues.
38-
39-
Images and real-life data make text more engaging and powerful, but be sure what
40-
you use is appropriately licensed and available. Here again, even a rough idea
41-
for artwork can be polished by others.
42-
43-
### Building the website
44-
45-
```{note}
46-
The NumPy tutorials are powered by [`jupyter-book`][jb-docs] and the
47-
[`MyST` document engine][mystmd].
48-
See the linked documentation for further details.
49-
```
50-
51-
[jb-docs]: https://jupyterbook.org/stable/
52-
[mystmd]: https://mystmd.org/
53-
54-
#### Quickstart
55-
56-
Set up a development environment with the dependencies listed in
57-
`requirements.txt` and `site/requirements.txt`.
58-
For example, using the built-in [`venv`][venv] module:
59-
60-
```bash
61-
python -m venv np-tutorials
62-
source np-tutorials/bin/activate
63-
python -m pip install -r requirements.txt -r site/requirements.txt
64-
```
65-
66-
[venv]: https://docs.python.org/3/library/venv.html
67-
68-
The site can then be built with:
69-
70-
```bash
71-
jupyter-book start --execute
72-
```
73-
74-
This will execute all the notebooks and start a web server to view the rendered
75-
content locally.
76-
View the rendered site by opening the ``localhost:30xy`` in your preferred browser (the exact port number will be printed in your terminal).
77-
78-
### Adding your own tutorials
79-
80-
If you have your own tutorial in the form of a Jupyter notebook (a `.ipynb`
81-
file) and you'd like to add it to the repository, follow the steps below.
82-
83-
84-
#### Create an issue
85-
86-
Go to [https://github.com/numpy/numpy-tutorials/issues](https://github.com/numpy/numpy-tutorials/issues)
87-
and create a new issue with your proposal. Give as much detail as you can about
88-
what kind of content you would like to write (tutorial, how-to) and what you
89-
plan to cover. We will try to respond as quickly as possible with comments, if
90-
applicable.
91-
92-
#### Check out our suggested template
93-
94-
You can use our [Tutorial Style Guide](content/tutorial-style-guide.md) to make
95-
your content consistent with our existing tutorials.
96-
97-
#### Upload your content
98-
99-
<ul>
100-
<details>
101-
<summary>
102-
<b>Fork this repository</b> (if you haven't before).
103-
</summary>
104-
<img src="site/_static/01-fork.gif" width=80% height=80%>
105-
</details>
106-
107-
<details>
108-
<summary>
109-
<b>In your own fork, create a new branch for your content.</b>
110-
</summary>
111-
<img src="site/_static/02-create_new_branch.gif" width=80% height=80%>
112-
</details>
113-
114-
<details>
115-
<summary>
116-
<b>Add your notebook to the <code>content/</code> directory.</b>
117-
</summary>
118-
<img src="site/_static/03-upload.gif" width=80% height=80%>
119-
</details>
120-
121-
<b>Update the <code>environment.yml</code> file with the dependencies for your
122-
tutorial</b> (only if you add new dependencies).
123-
124-
<details>
125-
<summary>
126-
<b>Update this <code>README.md</code> to include your new entry.</b>
127-
</summary>
128-
<img src="site/_static/04-add_to_readme.gif" width=80% height=80%>
129-
</details>
130-
131-
<b>Update the attribution section (below) to credit the original tutorial
132-
author, if applicable.</b>
133-
134-
<details>
135-
<summary>
136-
<b>Create a <a href="https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests">pull request.</a>
137-
Make sure the "Allow edits and access to secrets by maintainers" option
138-
is selected so we can properly review your submission.</b>
139-
</summary>
140-
<img src="site/_static/05-create_PR.gif" width=80% height=80%>
141-
</details>
142-
143-
:tada: <b>Wait for review!</b>
144-
</ul>
145-
146-
For more information about GitHub and its workflow, you can see
147-
[this document](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests).
148-
149-
150-
### Building the Sphinx site locally
151-
152-
Building the tutorials website, which is published at
153-
https://github.com/numpy/numpy-tutorials, locally isn't necessary before making
154-
a contribution, but may be helpful:
155-
156-
```bash
157-
conda env create -f environment.yml
158-
conda activate numpy-tutorials
159-
cd site
160-
make html
161-
```
162-
16328
## Translations
16429

16530
While we don't have the capacity to translate and maintain translated versions

0 commit comments

Comments
 (0)