systers.github.io/open-source-workflow.html at master · khalbazee/systers.github.io · GitHub

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
<!doctype html>
<html>
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="chrome=1">
    <title>Systers Open Source Projects by Systers</title>

    <link rel="stylesheet" href="/stylesheets/styles.css">
    <link rel="stylesheet" href="/stylesheets/fontawesome-all.css">
    <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
    <link rel="icon" href="/images/favicon.png">
  </head>

  <body>
    <header>
    <a href="#main-menu"
        class="menu-toggle"
        role="button"
        id="main-menu-toggle"
        aria-expanded="false"
        aria-controls="main-menu"
        aria-label="Open main menu">
        <span class="sr-only">Open main menu</span>
        <span class="fa fa-bars hamburger" aria-hidden="true"></span>
    </a>

    <div>
            <a href="/"><img class="logo" src="/images/systers-logo.png"
                          alt="Systers - Anitab.org logo"></a>
    </div>

  <nav id="main-menu"
        class="main-menu"
        role="navigation"
        aria-expanded="false"
        aria-label="Main menu">
    <a href="#main-menu-toggle"
        class="menu-close"
        role="button"
        id="main-menu-close"
        aria-expanded="false"
        aria-controls="main-menu"
        aria-label="Close main menu">
        <span class="sr-only">Close main menu</span>
        <span class="fa fa-close" aria-hidden="true"></span>
    </a>
    <ul>
        <li><a href="/index.html#join-systers">Join Systers</a></li>
        <li><a href="/index.html#projects">Projects</a></li>
        <li><a href="/index.html#programs">Programs</a></li>
        <li class="toggle"><a href="#main-menu">Contribute<span class="fas fa-chevron-down"></span></a>
            <ul>
              <li><a href="/newcomers">Newcomers</a></li>
              <li><a href="/open-source-workflow">Open Source Workflow</a></li>
              <li><a href="/member-levels">Member Levels</a></li>
            </ul>
        </li>
            <li class="toggle"><a href="#main-menu">About Us <span class="fas fa-chevron-down"></span></a>
            <ul>
              <li><a href="/contactus.html">Contact Us</a></li>
              <li><a href="/code-of-conduct">Code of Conduct</a></li>
              <li><a href="/reporting-guidelines">Reporting Guidelines</a></li>
            </ul>
        </li>
    </ul>
    </nav>
    <a href="#main-menu-toggle"
    class="backdrop"
    tabindex="-1"
    aria-hidden="true"
    hidden></a>
  </header>

<div class="header"><h1>Open Source Workflow</h1></div>
<p>Below is the process that Systers uses to plan, create, test, and deploy our various projects within GitHub.  These are the steps that should be taken whenever contributing to any of our repositories.</p>
<div class="subheader"><h2>Development Life Cycle</h2></div>

  <img src="/images/workflow.png" class="workflowCircle">

  <div class="workflowBlush1 workflowChart">
  <h4 class="requirements">Requirements Analysis</h4>
  <p class="ombre">Project Requirements Document <i class="fas fa-long-arrow-alt-right"></i> Create Issues <i class="fas fa-long-arrow-alt-right"></i> Approved by Mentor or Maintainer <i class="fas fa-long-arrow-alt-right"></i> </p>
  </div>

  <div class="workflowBlush2 workflowChart">
  <h4 class="requirements">Design</h4>
  <p class="ombre">Create Mock-Ups for the Issue <i class="fas fa-long-arrow-alt-right"></i> Reviewed by Mentor or Maintainer <i class="fas fa-long-arrow-alt-right"></i> Adjust Mock-Up Based on Feedback <i class="fas fa-long-arrow-alt-right"></i> Approved by Mentor or Maintainer <i class="fas fa-long-arrow-alt-right"></i></p>
  </div>

  <div class="workflowBlush3 workflowChart">
  <h4 class="requirements">Development & Testing (TDD)</h4>
  <p class="ombre">Fix the Issue <i class="fas fa-long-arrow-alt-right"></i> Open a Pull Request <i class="fas fa-long-arrow-alt-right"></i> Reviewed by Mentor or Maintainer <i class="fas fa-long-arrow-alt-right"></i> Adjust Based on Feedback <i class="fas fa-long-arrow-alt-right"></i> Approved by Mentor or Maintainer <i class="fas fa-long-arrow-alt-right"></i></p>
  </div>

  <div class="workflowBlush4 workflowChart">
    <h4 class="requirements">Testing</h4>
    <p class="ombre">Create Issues that Test the Applications in Production (i.e. User Tests, Feature Tests, etc.) <i class="fas fa-long-arrow-alt-right"></i> Reviewed by Committer <i class="fas fa-long-arrow-alt-right"></i> Submit PRs that Contain Documentation on Tests to Suggest Improvements for Next Release <i class="fas fa-long-arrow-alt-right"></i> Approved by Committer <i class="fas fa-long-arrow-alt-right"></i></p>
  </div>

  <div class="workflowBlush5 workflowChart">
        <h4 class="requirements">Maintenance</h4>
        <p class="ombre">Create Issues that Fix Errors, Improve Implementation, or Upgrade the Current Language <i class="fas fa-long-arrow-alt-right"></i> Approved by Mentor, Maintainer, or Committer</p>
      </div>


  <div class="subheader"><h2>Before Merging a Pull Request</h2></div>
  <p>Even when starting with a rebased branch, it’s possible to encounter merge conflicts.</p>
<ol>
    <li>Ensure the PR was sent to the correct branch.</li>
    <li>If there are unnecessary merge commits squash and merge, or ask the contributor to do it again by rebasing (removing the merge commit).
        <ol type="a">
        <li>If the PR is from a new contributor explain that it will be rebased, then do a squash and merge. We don’t want people to be discouraged.</li>
        <li>If someone has unnecessary merge commits frequently, do not merge until they send a PR with merge commits removed.</li>
        </ol>
    </li>
</ol>

<div class="subheader"><h2>Squash Commits</h2></div>
<p>Systers’ workflow is based around squashing PR’s into a single commit before merging. This can be done on the GitHub interface or, if you prefer, in the command line using Git.</p>

<blockquote>When you select the Squash and merge option on a pull request on GitHub, the pull request's commits are squashed into a single commit. Instead of seeing all of a contributor's individual commits from a topic branch, the commits are combined into one commit and merged into the default branch.</blockquote>
<p class="footer">Wording from <a href="https://help.github.com/articles/about-pull-request-merges/">Github Documentation</a></p>

<footer>
        <div class="footerLine">
        <p>Find us at:</p>
        <ul class="socialMedia">
            <li><a href="https://twitter.com/systers_org"><img src="/images/twitter.png" class="squareLogo"></a></li>
            <li><a href="https://www.facebook.com/AnitaB.0rg/"><img src="/images/facebook.png" class="squareLogo"></a></li>
            <li><a href="https://www.youtube.com/channel/UCUvti1DEKYUZBtQqQAtCK6g/videos"><img src="/images/youtube.png" class="squareLogo"></a></li>
            <li><a href="https://medium.com/@systers_org"><img src="/images/medium.png" class="squareLogo"></a></li>
            <li><a href="https://systers-opensource.blogspot.com/"><img src="/images/blogger.png" class="squareLogo"></a></li>
        </ul>
        <img src="/images/footer-bars.png" class="footerBars">
        </div>
    </footer>

</body>
</html>