-
Notifications
You must be signed in to change notification settings - Fork 0
/
contributing.t2t
97 lines (61 loc) · 2.4 KB
/
contributing.t2t
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
Security APAR Assistant
Contributing
%!includeconf: inc/config.t2t
%!include: inc/menu.t2t
SAAssist Server (saassist-server) is developed in Python (version 3) language
and SAAssist Client (saassist-client) is developed in Korn Shell (ksh).
%%TOC
= Reporting bugs =
SAAssist Server https://github.com/SAAssist/saassist-server/issues
SAAssist Client https://github.com/SAAssist/saassist-client/issues
= To Do =
- [server/client] Implement checksum for files
- [server/client] Implement support to IBM System Mirror(PowerHA/HACMP), Java
OpenSSL, OpenSSH etc (all 'external packages')
- [server/client] Include support for ftp protocol
- [server] Create all unit tests for Python code
- --[server] Avoid to store the same fix for different versions to reduce--
--data storage usage.--
= New code or bug fixes =
1. Create your account on GitHub (https://github.com)
2. Create your account on GerritHub (https://review.gerrithub.io) using your
GitHub account
3. Do the fork from http://github.com/SAAssist/saassist-server or saassist-client
4. Do the clone from your fork ``git clone https://github.com/username/saassist-server``
5. Create a branch ``git checkout -b new_feature`` or ``git checkout -b bug_000X``
6. Do your code or fix a bug :)
7. Run tests ``tox -e py34`` (Not required for saassist-client)
8. Submit your code to review ``git-review``
= Project Overview =
== saassist-server structure ==
```
* server_config.py is the configuration file (basic variables)
* saassist-server(.py) is the command constructor
* saassist/saaserver.py is the server manager (repository content manager)
- SAAServer()
. repo_creation()
* saassist/datacollector.py is the data collector that works with FLRT site
- Collector()
. apar_data()
```
=== SCHEMA ===
```
1. [ saassist-server.py ]
{ user: CVE / IV }
{ user: update or no }
--> saassist/saaserver.py
2. [ saassist/saaserver.py ]
{ invoke datacollector.py with CVE/IV }
--> saassist/datacollector.py
3. [ saassist/datacollector.py ]
{ access FLRT website }
{ do parsing of data }
{ return the data in a dictionary }
saassist/saaserver <--
4. [ saassist/saaserver.py ]
{ validate data }
{ create the repository data }
{ output actions: user }
```
== saassist-client structure ==
saassist-client is a simple Korn Shell (ksh)