-
Notifications
You must be signed in to change notification settings - Fork 0
/
contributing.html
161 lines (136 loc) · 4.71 KB
/
contributing.html
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<meta name="author" content="Kairo Araujo">
<META NAME="generator" CONTENT="http://txt2tags.org">
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8">
<LINK REL="stylesheet" TYPE="text/css" HREF="site.css">
<TITLE>Security APAR Assistant</TITLE>
<link rel="icon" type="image/png" href="/favicon.png">
</HEAD>
<BODY>
<DIV CLASS="header" ID="header">
<H1>Security APAR Assistant</H1>
<H3>Contributing</H3>
</DIV>
<DIV CLASS="body" ID="body">
<div id="sidebar">
<ul>
<li id="home"><a href="./index.html">Home</a></li>
<li id="howitworks"><a href="./howitworks.html">How it Works</a></li>
<li id="SAAssist Server Doc"><a href="./saassist-server_doc.html">SAAssist Server Doc</a></li>
<li id="SAAssist Client Doc"><a href="./saassist-client_doc.html">SAAssist Client Doc</a></li>
<li id="Developing / Contributing"><a href="./contributing.html">Developing / Contributing</a></li>
<li id="SAA Server releases"><a href="https://github.com/saassist/saassist-server/releases">SAA Server Download</a></li>
<li id="SAA CLient releases"><a href="https://github.com/saassist/saassist-client/releases">SAA Client Download</a></li>
<li id="github"><a href="https://github.com/saassist">Visit GitHub</a></li>
</ul>
</div>
<P>
SAAssist Server (saassist-server) is developed in Python (version 3) language
and SAAssist Client (saassist-client) is developed in Korn Shell (ksh).
</P>
<DIV CLASS="toc">
<UL>
<LI><A HREF="#toc1">Reporting bugs</A>
<LI><A HREF="#toc2">To Do</A>
<LI><A HREF="#toc3">New code or bug fixes</A>
<LI><A HREF="#toc4">Project Overview</A>
<UL>
<LI><A HREF="#toc5">saassist-server structure</A>
<UL>
<LI><A HREF="#toc6">SCHEMA</A>
</UL>
<LI><A HREF="#toc7">saassist-client structure</A>
</UL>
</UL>
</DIV>
<A NAME="toc1"></A>
<H1>Reporting bugs</H1>
<P>
SAAssist Server <A HREF="https://github.com/SAAssist/saassist-server/issues">https://github.com/SAAssist/saassist-server/issues</A>
</P>
<P>
SAAssist Client <A HREF="https://github.com/SAAssist/saassist-client/issues">https://github.com/SAAssist/saassist-client/issues</A>
</P>
<A NAME="toc2"></A>
<H1>To Do</H1>
<UL>
<LI>[server/client] Implement checksum for files
<LI>[server/client] Implement support to IBM System Mirror(PowerHA/HACMP), Java
OpenSSL, OpenSSH etc (all 'external packages')
<LI>[server/client] Include support for ftp protocol
<LI>[server] Create all unit tests for Python code
<LI><S>[server] Avoid to store the same fix for different versions to reduce</S>
<S>data storage usage.</S>
</UL>
<A NAME="toc3"></A>
<H1>New code or bug fixes</H1>
<P>
1. Create your account on GitHub (<A HREF="https://github.com">https://github.com</A>)
</P>
<P>
2. Create your account on GerritHub (<A HREF="https://review.gerrithub.io">https://review.gerrithub.io</A>) using your
GitHub account
</P>
<P>
3. Do the fork from <A HREF="http://github.com/SAAssist/saassist-server">http://github.com/SAAssist/saassist-server</A> or saassist-client
</P>
<P>
4. Do the clone from your fork <CODE>git clone https://github.com/username/saassist-server</CODE>
</P>
<P>
5. Create a branch <CODE>git checkout -b new_feature</CODE> or <CODE>git checkout -b bug_000X</CODE>
</P>
<P>
6. Do your code or fix a bug :)
</P>
<P>
7. Run tests <CODE>tox -e py34</CODE> (Not required for saassist-client)
</P>
<P>
8. Submit your code to review <CODE>git-review</CODE>
</P>
<A NAME="toc4"></A>
<H1>Project Overview</H1>
<A NAME="toc5"></A>
<H2>saassist-server structure</H2>
<PRE>
* 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()
</PRE>
<A NAME="toc6"></A>
<H3>SCHEMA</H3>
<PRE>
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 }
</PRE>
<A NAME="toc7"></A>
<H2>saassist-client structure</H2>
<P>
saassist-client is a simple Korn Shell (ksh)
</P>
</DIV>
<!-- html code generated by txt2tags 2.6 (http://txt2tags.org) -->
<!-- cmdline: txt2tags -\-toc contributing.t2t -->
</BODY></HTML>