Skip to content

Commit 105f5f3

Browse files
authored
Merge pull request visualpython#28 from visualpython/contributing
Create CONTRIBUTING.md
2 parents 2dcca66 + 7fe3dea commit 105f5f3

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

CONTRIBUTING.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Contributing to the Visual Python
2+
3+
Dear contributors, thanks for your interest in Visual Python. <br>
4+
We welcome all skills from:
5+
* [Programmers](#Programmers)
6+
* [Non-programmers](#Non-programmers)
7+
* [Designers](#Designers) <br>
8+
9+
10+
and your contribution would be greatly appreciated ! <br><br>
11+
12+
## Programmers
13+
14+
### Responding to an issue
15+
1. Find an issue you would like to work on.
16+
2. Follow the process from [GitHub Guides: Forking Projects](https://guides.github.com/activities/forking/)
17+
18+
NOTE : Any submissions are understood to be under the same GPLv3 License that covers the project.
19+
20+
* GUI Kit available as a Figma library: [Visual Python GUI Kit 1.0](https://www.figma.com/community/file/976035035360380841).
21+
22+
23+
### Creating an issue
24+
1. Go to [Issues], click [New Issue].
25+
2. Select the issue template: [Bug Report](https://github.com/visualpython/visualpython/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5BBUG%5D+) / [Feature Request](https://github.com/visualpython/visualpython/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=) / [Blank](https://github.com/visualpython/visualpython/issues/new)
26+
3. Write a clear and concise description.
27+
4. Submit a new issue.
28+
29+
NOTE : If you are reporting a bug, please include steps to reproduce the problem. <br>
30+
31+
32+
## Non-programmers
33+
34+
### Creating & Sharing VP Notes
35+
1. Create a data analysis task note using Visual Python.
36+
2. Save the note as a (.vp) format.
37+
3. Share your work and knowledge on [Visual Python Hub](https://www.visualpython.ai/vpnote).
38+
39+
NOTE : Your work can be of great help for someone who struggles to find a solution.
40+
41+
### Contributing to Documentation
42+
* Help with reviewing and editing official project documentation.
43+
44+
### Helping raise a better awareness of Visual Python
45+
* Create educational material using Visual Python.
46+
* Create content like videos, blogs that you can share your experience and ideas about Visual Python.
47+
48+
49+
## Designers
50+
51+
### Responding to a design-related issue
52+
1. Find a design-related issue you would like to work on.
53+
2. Follow the process from [GitHub Guides: Forking Projects](https://guides.github.com/activities/forking/)
54+
55+
### Improving UI Kit
56+
1. Take a look at the latest version on Figma: [Visual Python GUI Kit 1.0](https://www.figma.com/community/file/976035035360380841).
57+
2. Duplicate the file to add a copy to your folder.
58+
3. Make changes on the copy and publish the file to Figma Community as a remix version.
59+
60+
NOTE : Recommend reading [Figma: Publish Community files](https://help.figma.com/hc/en-us/articles/360040035974-Publish-Community-files) before starting the work for better understanding of the system.
61+
62+
<br>
63+

0 commit comments

Comments
 (0)