Skip to content

Commit 4e00f6d

Browse files
committed
Update CONTRIBUTING.md
1 parent a78b3c6 commit 4e00f6d

File tree

1 file changed

+46
-8
lines changed

1 file changed

+46
-8
lines changed

CONTRIBUTING.md

Lines changed: 46 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,52 @@
11
# Contributing Guidelines
22

3-
Contributions welcome!
3+
We value your participation in this open source project. This page will give you a quick overview of how to get involved.
44

5-
**Before spending lots of time on something, ask for feedback on your idea first!**
5+
## Important Note
66

7-
Please search issues and pull requests before adding something new to avoid duplicating efforts and conversations.
7+
- Do not raise issues or send PRs for changing issue template, adding header-footer, badges or any buttons.
8+
- Do not raise issues or send PRs for for any website changes.
89

9-
This project welcomes following types of contributions:
10+
## How can I contribute?
1011

11-
- **Ideas**: participate in an issue thread or start your own to have your voice heard.
12-
- **Writing**: contribute your expertise in an area by helping expand the included content.
13-
- **Copy editing**: fix typos, clarify language, and generally improve the quality of the content.
14-
- **Formatting**: help keep content easy to read with consistent formatting.
12+
You can contribute to this project by adding content on a new topic or improving existing content.
13+
14+
The list of topics for which we are looking for content are provided below along with the location where the content has to be added:
15+
16+
- Advanced Python - [Link](https://github.com/animator/learn-python/tree/main/contrib/advanced-python)
17+
- Pandas - [Link](https://github.com/animator/learn-python/tree/main/contrib/pandas)
18+
- NumPy - [Link](https://github.com/animator/learn-python/tree/main/contrib/numpy)
19+
- SciPy - [Link](https://github.com/animator/learn-python/tree/main/contrib/scipy)
20+
- Data Science & Machine Learning - [Link](https://github.com/animator/learn-python/tree/main/contrib/machine-learning)
21+
- Plotting & Visualization - [Link](https://github.com/animator/learn-python/tree/main/contrib/plotting-visualization)
22+
- Interacting with Databases - [Link](https://github.com/animator/learn-python/tree/main/contrib/database)
23+
- Web Scrapping - [Link](https://github.com/animator/learn-python/tree/main/contrib/web-scrapping)
24+
- API Development - [Link](https://github.com/animator/learn-python/tree/main/contrib/api-development)
25+
- Data Structures & Algorithms - [Link](https://github.com/animator/learn-python/tree/main/contrib/ds-algorithms)
26+
- Python Mini Projects - [Link](https://github.com/animator/learn-python/tree/main/contrib/mini-projects)
27+
- Python Question Bank - [Link](https://github.com/animator/learn-python/tree/main/contrib/question-bank)
28+
29+
You can check out some content ideas below.
30+
31+
## Process
32+
33+
**Step 1**: Raise a **new issue** that you want to "Add <Your content title> content". We will assign the issue to you and label it.
34+
**Step 2**: Star and fork THIS repository.
35+
**Step 3**: Now in your fork, go the correct topic folder as provided in the links above.
36+
**Step 4**: Edit `index.md` file to add the title of the content and the corresponding file name where the content will be available in this folder.
37+
**Step 5**: Add the content in the file.
38+
**Step 6**: Raise a PR with your changes. Accept the pledge that the content is original and not stolen from any other source.
39+
**Step 7**: Wait for review and PR merge.
40+
41+
### Some Content Ideas
42+
43+
- **NumPy**: Introduction, Arrays, Indexing and Slicing, Operations on Arrays, Concatenating Arrays, Reshaping Arrays, Splitting Arrays, Statistical Operations on Arrays, Loading Arrays from Files, Saving NumPy Arrays in Files, etc.
44+
- **Pandas**: Introduction, Importing and Exporting Data, DataFrames, Pandas Series Vs NumPy ndarray, Descriptive Statistics, Data Aggregations, Sorting a DataFrame, Group by Functions, Altering the Index, Other DataFrame Operations, Handling Missing Values, Import and Export of Data between Pandas and MySQL, Pandas plotting, etc.
45+
- **Plotting & Visualization**: Matplotlib, Seaborn, Customisation of Plots (Marker, colour, Line width and Line Style), Line chart, Bar Chart, Histogram, Scatter Chart, Plotting Quartiles and Box plot, Pie Chart, etc.
46+
- **Data Science & Machine Learning**: Scikit-learn, TensorFlow, PyTorch, regression, classification, clustering, ensemble model, deep learning, etc.
47+
- **API Development**: Building APIs using FastAPI, CRUD API Development, etc.
48+
- **Advanced Python**: OOP In Python, Generators, List Comprehensions, Lambda functions, In-depth Function Arguments, Regular Expressions, Exception Handling, Partial functions, Code Introspection, Closures, Decorators, Map, Filter, Reduce, etc.
49+
50+
### Any doubt?
51+
52+
In case you are new to the open source ecosystem, we would be more than happy to guide you through the entire process. Just join our [Discord server](https://bit.ly/heyfoss) and drop a message in relevant channel.

0 commit comments

Comments
 (0)