editing WINDOWS_INSTALL.md and CONTRIBUTING.md

This commit is contained in:
Pilar 2022-04-12 10:47:22 -04:00
parent 43c0abdd04
commit f93bdbe5c3
10 changed files with 32 additions and 8 deletions

View File

@ -2,13 +2,14 @@
## Push Request Checklist ## Push Request Checklist
Before sending your pull requests, make sure you followed this list. Before sending your pull requests, make sure you completed this checklist:
- Read [contributing guidelines](CONTRIBUTING.md). - Read to the end [this document](CONTRIBUTING.md).
- Read [Code of Conduct](CODE_OF_CONDUCT.md). - Read [Code of Conduct](CODE_OF_CONDUCT.md).
- Check if my changes are consistent with the [guidelines](CONTRIBUTING.md#user-content-general-guidelines-and-philosophy-for-contribution). - Check if your changes are consistent with the [Guidelines](CONTRIBUTING.md#user-content-general-guidelines-and-philosophy-for-contribution).
- Changes are consistent with the [Coding Style](CONTRIBUTING.md#user-content-coding-style). - Check if your changes are consistent with the [Coding Style](CONTRIBUTING.md#user-content-coding-style).
- Manually test your code and add [Unit Tests](CONTRIBUTING.md#user-content-testing-best-practices). - Manually test your code and add [Unit Tests](CONTRIBUTING.md#user-content-testing-best-practices).
- Be sure that you didn't brake anything by running all unit tests in folder unittests (right click on the folder and click on the green play).
- [Document your work](CONTRIBUTING.md#user-content-documentation). - [Document your work](CONTRIBUTING.md#user-content-documentation).
## How to become a contributor and submit your own code ## How to become a contributor and submit your own code

View File

@ -34,6 +34,25 @@ If that message does not appear is because you have it already installed in your
![pycharm project screen](./docs/img/img_2.png) ![pycharm project screen](./docs/img/img_2.png)
6. Create your working branch by right clicking on the project folder (libs) -> Git -> Repository -> Branches:
![create new branch 1](./docs/img/img_9.png)
And then + New Branch:
![create new branch 2](./docs/img/img_10.png)
Give a name to your branch and open the tab Git at the down-left corner. Right click on your branch and push.
![push new branch 1](./docs/img/img_11.png)
![push new branch 2](./docs/img/img_12.png)
Check that your branch appears in the Remote list:
![check all set](./docs/img/img_13.png)
If your branch is there, you are done with this part.
# Configure PyCharm. # Configure PyCharm.
@ -45,11 +64,15 @@ This option can be configured in PyCharm at the settings screen, as shown in the
# Start your project. # Start your project.
1. Click on File -> New Project... The following window opens: 1. At our Git (https://rs-loy-gitlab.concordia.ca/), click on New project:
![pycharm new project screen](./docs/img/img_3.png) ![git new project screen](./docs/img/img_14.png)
Add a name to your project and click Create. The create a black project with the desired name (remember to follow our ![Coding Style](PYGUIDE.md)).
![git give a name](./docs/img/img_15.png)
And finally, clone it following the same steps as with ![libs](WINDOWS_INSTALL.md#get-the-code) (steps 3 to 5).
2. Go to project settings and add the libs project to your own, by clicking on Add Content Root: 2. Go to project settings and add the libs project to your own, by clicking on Add Content Root:
@ -72,4 +95,4 @@ from imports.geometry_factory import GeometryFactory
city = GeometryFactory('citygml', 'myfile.gml').city city = GeometryFactory('citygml', 'myfile.gml').city
``` ```
The rest depends on you. Have fun! 5. Always remember to push your own project changes as the last thing you do before ending your working day!

BIN
docs/img/img_10.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.4 KiB

BIN
docs/img/img_11.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 77 KiB

BIN
docs/img/img_12.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

BIN
docs/img/img_13.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

BIN
docs/img/img_14.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

BIN
docs/img/img_15.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

BIN
docs/img/img_16.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 83 KiB

BIN
docs/img/img_9.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 159 KiB