s_ranjbar/summer_course_2024
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

editing WINDOWS_INSTALL.md and CONTRIBUTING.md

Browse Source
This commit is contained in:
Pilar 2022-04-12 14:14:20 -04:00
parent f93bdbe5c3
commit c4a6ea61fc
2 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@ -16,13 +16,20 @@ Before sending your pull requests, make sure you completed this checklist:
### Contributor License Agreements ### Contributor License Agreements
CERC Libs is an [LGPL licensed](LICENSE.md) software, so even if we'd love to accept your patches, Before we can take them, please be sure that you are the intellectual property owner of your code and that do you fully understand and respect our software license. CERC Libs is an [LGPL licensed](LICENSE.md) software, so even if we'd love to accept your patches, before we can take them,
please be sure that you are the intellectual property owner of your code and that do you fully understand and respect our software license.
***NOTE***: Only source code that you own will go into the main repository. ***NOTE***: Only source code that you own will go into the main repository.
### Contributing code ### Contributing code
If you have improvements to CERC Libs or want to extend the functionality, please send us your pull request as seen at [git pull request documentation](https://git-scm.com/docs/git-request-pull) If you made any changes in your own project, just push them to git. You are the owner, you are the manager.
To do so, first, commit your changes by clicking on the green check at the top-right corner of Pycharm. Add a comment that explains briefly your changes.
Then, pull by clicking on the blue arrow to be sure that there are no conflicts between your version (local) and the one in gitlab (remote).
Once the conflicts are solved and the merge in local is done, push the changes by clicking on the green arrow.
If you have improvements to CERC Libs or want to extend the functionality, please send us your pull request as seen at [git pull request documentation](https://git-scm.com/docs/git-request-pull). Or click on
Once the pull requests are approved and pass continuous integration checks, a team member will merge your changes on CERC Libs, and your code will become an integral part of Insel4D platform. Once the pull requests are approved and pass continuous integration checks, a team member will merge your changes on CERC Libs, and your code will become an integral part of Insel4D platform.

10
WINDOWS_INSTALL.md
View File

@ -68,11 +68,12 @@ This option can be configured in PyCharm at the settings screen, as shown in the
![git new project screen](./docs/img/img_14.png) ![git new project screen](./docs/img/img_14.png)
The create a black project with the desired name (remember to follow our ![Coding Style](PYGUIDE.md)). The create a black project with the desired name (remember to follow our ![Coding Style](PYGUIDE.md)).
Be sure that Initialize repository with a README is selected, and ideally, that the Visibility Level is Public.
![git give a name](./docs/img/img_15.png) ![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). And finally, clone it following the same steps as for ![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:
@ -95,4 +96,7 @@ from imports.geometry_factory import GeometryFactory
city = GeometryFactory('citygml', 'myfile.gml').city city = GeometryFactory('citygml', 'myfile.gml').city
``` ```
5. Always remember to push your own project changes as the last thing you do before ending your working day! 5. Always remember to push your own project changes as the last thing you do before ending your working day!
First, commit your changes by clicking on the green check at the top-right corner of Pycharm. Add a comment that explains briefly your changes.
Then, pull by clicking on the blue arrow to be sure that there are no conflicts between your version (local) and the remote one (gitlab).
Once the conflicts are solved and the merge in local is done, push the changes by clicking on the green arrow.