Skip to content

Commit 4896466

Browse files
minjk-blminjk-bl
authored
Merge pull request #32 from minjk-bl/devops
Devops
2 parents 0e0b6fa + dd4b2ab commit 4896466

18 files changed

Lines changed: 1478 additions & 59 deletions

‎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+

‎README.md‎

Lines changed: 8 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,12 @@
1-
<!--
2-
#========================================================================
3-
# Filename : README.md
4-
# Function : control visualpython for Window/Linux/Mac
5-
# Creator : Black Logic
6-
# Version : 1.1.1
7-
# License : GPLv3
8-
# Date : 2020 07.27
9-
# Mdate : 2021 05.07
10-
#========================================================================
11-
-->
12-
131
# Visual Python
14-
152
[![PyPI version shields.io](https://img.shields.io/pypi/v/visualpython)](https://pypi.python.org/pypi/visualpython/)
163
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-green)](https://www.gnu.org/licenses/gpl-3.0.html)
17-
[![Website: VP Hub](https://img.shields.io/badge/Website-VP%20Hub-orange)](https://www.visualpython.ai)
18-
19-
20-
<br>
4+
[![Code of Conduct: Contributor Covenant](https://img.shields.io/badge/Code%20of%20Conduct-Contributor%20Covenant-blueviolet)](https://github.com/visualpython/visualpython/blob/main/CODE_OF_CONDUCT.md)
215

226
## Introduction
237
Visual Python is a GUI-based Python code generator, developed on the Jupyter Notebook environment as an extension.
24-
<br>
8+
9+
<img src="https://i.esdrop.com/d/7o0dj05m8rnz/sgKUVlLpRx.png" width="85%">
2510

2611
1. Key Features
2712
* Automatically generates Python code based on a graphic user interface <br>
@@ -39,7 +24,6 @@ Non-programmers will be able to : <br>
3924
* learn the Python language more easily <br>
4025
* manage big data with minimal coding skills <br>
4126

42-
<br>
4327

4428
## Getting Started
4529

@@ -93,20 +77,18 @@ uninstall - uninstall packages
9377
upgrade - version upgrade
9478
version - version check
9579
```
96-
<br>
97-
98-
## Mission & Vision
9980

10081

82+
## Mission & Vision
10183
**Mission** <br>
10284
To support technology and education so that anyone can leverage big data analytics to create a variety of social values.
10385

10486
**Vision** <br>
105-
To create an environment where you can learn and use big data analytics skills easily.
87+
To create an environment where everyone can learn and use big data analytics skills easily.
10688

107-
108-
<br>
89+
## Contributing
90+
If you are interested in contributing to the Visual Python, please see [`CONTRIBUTING.md`](CONTRIBUTING.md). <br>
91+
All skills from programmers, non-programmers, designers are welcomed.
10992

11093
## License
111-
11294
GNU GPLv3 (See LICENSE file).

0 commit comments

Comments
 (0)