finished CONTRIBUTING_CENTRAL_DATA_MODEL.md
|
@ -8,7 +8,7 @@ to integrate your data model with the Central Data Model.
|
|||
## Starting with the basics
|
||||
- Install all requirements and download the Libs project. [Here](WINDOWS_INSTALL.md) how to do it for windows.
|
||||
In order to maintain a good quality code, we will work in branches. New codes will need to pass quality standards before being accepted in the main branch.
|
||||
- Check and follow our [coding style](PYGUIDE.md)
|
||||
- Check and follow our [coding style](PYGUIDE.md).
|
||||
- Don’t forget to create unit tests and ensure that the old ones pass normally after your changes.
|
||||
- Imperative! Document your work using comments in the code and, if needed, adding text files with extended explanations.
|
||||
|
||||
|
@ -79,6 +79,81 @@ It is important to highlight that all setters and getters (@property) must have
|
|||
|
||||
Once you finish doing your changes, you should commit and push them to your branch. The name of the new files will change from green to white.
|
||||
|
||||
## Requesting a merge to the main branch
|
||||
### Add a plugin
|
||||
First, it is required to install a plugin for such purpose. We recommend [GitLab Merge Requests](https://plugins.jetbrains.com/plugin/18689-gitlab-merge-requests),
|
||||
but you are free to choose the one you prefer. In order to install the plug, be sure that you have the latest pycharm version.
|
||||
Go to Help -> Check for Updates... It will ask you to Update the new version, click on Update and Restart and follow the instructions.
|
||||
|
||||
![update pycharm](./docs/img_contributing/img_9.png)
|
||||
|
||||
Don't forget to look in the bottom-right corner, there you always find the instructions, warnings, errors, announcements...
|
||||
|
||||
![pycharm announcement](./docs/img_contributing/img_10.png)
|
||||
|
||||
Once you updated pycharm, go to File -> Settings... -> Plugins and search for _GitLab Merge Request_ and press Install.
|
||||
|
||||
![pycharm plugins](./docs/img_contributing/img_11.png)
|
||||
|
||||
### Select the project
|
||||
This step needs to be done only the first time.
|
||||
|
||||
Once the plugin is installed, it will appear a new tab at the bottom list called Gitlab Merge Requests as in the image:
|
||||
|
||||
![new tab](./docs/img_contributing/img_12.png)
|
||||
|
||||
Click on _Clik to discover servers_ and select the gitlab.concordia.ca.
|
||||
|
||||
![new server](./docs/img_contributing/img_13.png)
|
||||
|
||||
Observe that in the top-right corner of the tab, the message has changed from _No Repository_ to _Repo: /Guille/libs_.
|
||||
|
||||
![new repo](./docs/img_contributing/img_14.png)
|
||||
|
||||
If you now click on Refresh Merge Request (see previous image), you will get a message asking for a token. As you don't have one yet, click on Create token.
|
||||
|
||||
![create token](./docs/img_contributing/img_15.png)
|
||||
|
||||
You will be sent to the gitlab repository to create a new token. Give a name to it and check all options.
|
||||
You are creating a token that has the same permits as your gitlab account has.
|
||||
|
||||
![create token in gitlab](./docs/img_contributing/img_16.png)
|
||||
|
||||
A new personal access token will be created. Copy and paste it in the Access Token box.
|
||||
A token is a personal and no-transferable key. Don't show it to anyone!
|
||||
|
||||
![copy token](./docs/img_contributing/img_17.png)
|
||||
|
||||
![paste token](./docs/img_contributing/img_18.png)
|
||||
|
||||
### Create merge request
|
||||
Every time you want to send some changes to the main branch (merge your branch to the main one)
|
||||
you will need to follow these steps.
|
||||
|
||||
Right clic on the blanc area and select + Create Merge Request.
|
||||
|
||||
![new merge request](./docs/img_contributing/img_19.png)
|
||||
|
||||
A window will appear with the information of the request:
|
||||
|
||||
![request info](./docs/img_contributing/img_20.png)
|
||||
|
||||
Clic on Assignees + and look for the project owner, in this case, Guillermo Gutierrez Morote.
|
||||
Select him as assignee and clic OK.
|
||||
|
||||
This action will send a request for the merge. Now wait until this is accepted or rejected. You will receive an email to
|
||||
the email account you use for gitlab with the answer.
|
||||
|
||||
Once the changes are accepted, go back to the main branch by selecting the Git tab (bottom-left). Right clic on Master and select Checkout.
|
||||
|
||||
![checkout master](./docs/img_contributing/img_24.png)
|
||||
|
||||
Now pull (blue arrow), and delete the branch.
|
||||
|
||||
![erase branch](./docs/img_contributing/img_26.png)
|
||||
|
||||
Now you have again the same version as in gitlab. For new changes, create a new branch and repeat the process.
|
||||
|
||||
## Documentation and authoring
|
||||
There can be two types of authors, that one who created the model and that one who coded it. If they are not the same person,
|
||||
in the headers of the classes must be just the name of the coder, who is the reference person to ask anything about the code,
|
||||
|
|
BIN
docs/img_contributing/img_10.png
Normal file
After Width: | Height: | Size: 27 KiB |
BIN
docs/img_contributing/img_11.png
Normal file
After Width: | Height: | Size: 55 KiB |
BIN
docs/img_contributing/img_12.png
Normal file
After Width: | Height: | Size: 18 KiB |
BIN
docs/img_contributing/img_13.png
Normal file
After Width: | Height: | Size: 8.5 KiB |
BIN
docs/img_contributing/img_14.png
Normal file
After Width: | Height: | Size: 200 KiB |
BIN
docs/img_contributing/img_15.png
Normal file
After Width: | Height: | Size: 4.8 KiB |
BIN
docs/img_contributing/img_16.png
Normal file
After Width: | Height: | Size: 82 KiB |
BIN
docs/img_contributing/img_17.png
Normal file
After Width: | Height: | Size: 77 KiB |
BIN
docs/img_contributing/img_18.png
Normal file
After Width: | Height: | Size: 7.0 KiB |
BIN
docs/img_contributing/img_19.png
Normal file
After Width: | Height: | Size: 201 KiB |
BIN
docs/img_contributing/img_20.png
Normal file
After Width: | Height: | Size: 454 KiB |
BIN
docs/img_contributing/img_21.png
Normal file
After Width: | Height: | Size: 29 KiB |
BIN
docs/img_contributing/img_22.png
Normal file
After Width: | Height: | Size: 76 KiB |
BIN
docs/img_contributing/img_23.png
Normal file
After Width: | Height: | Size: 233 KiB |
BIN
docs/img_contributing/img_24.png
Normal file
After Width: | Height: | Size: 257 KiB |
BIN
docs/img_contributing/img_25.png
Normal file
After Width: | Height: | Size: 206 KiB |
BIN
docs/img_contributing/img_26.png
Normal file
After Width: | Height: | Size: 210 KiB |
BIN
docs/img_contributing/img_8.png
Normal file
After Width: | Height: | Size: 174 KiB |
BIN
docs/img_contributing/img_9.png
Normal file
After Width: | Height: | Size: 15 KiB |