automatic-contract-summarizer-portal/contrib.html at main · devgateway/automatic-contract-summarizer-portal · 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
<!doctype html>
<html lang="en">
<head>
    <meta charset="utf-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1"/>
    <title>Contrib • Automatic Contract Summarizer</title>
    <link href="assets/site.css" rel="stylesheet"/>
    <link rel="preconnect" href="https://fonts.googleapis.com">
    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
    <link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;600;800&display=swap" rel="stylesheet">
</head>
<body>
<header>
    <div class="container">
        <nav>
            <a class="item" href="index.html">Home</a>
            <a class="item" href="architecture.html">Architecture</a>
            <a class="item" href="contrib.html">Contrib</a>
            <a class="item" href="guide.html">Guide</a>
            <a class="item" href="https://developmentgateway.org/" target="_blank">DG</a>
            <a class="item" href="https://github.com/devgateway/automatic-contract-summarizer/ target="_blank"">Github</a>
            <a class="item" href="install.html">Install</a>
            <a class="item" href="license.html">LICENSE</a>
            <a class="item" href="privacy.html">Privacy</a>
        </nav>
    </div>
</header>
<main>
    <section>
        <div class="container">
            <div class="post-content">
                <h1 id="how-to-contribute">How to contribute</h1>

                <p>For general bugs and requests, you can use <a
                        href="https://github.com/devgateway/automatic-contract-summarizer/issues">our
                    issues page</a> on the Github project page.</p>

                <p>If you want to contribute code directly, you can use the general Github recommendation for
                    contributing to open source projects, found <a
                            href="https://docs.github.com/en/get-started/quickstart/contributing-to-projects">here</a>.
                </p>

                <p>We summarize below the main steps:</p>

                <h2 id="fork-the-repo">Fork the repo</h2>

                <p>A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes
                    without affecting the original project.</p>

                <p>See a complete description of what a fork is and how to make one on Github, <a
                        href="https://docs.github.com/en/get-started/quickstart/fork-a-repo">here</a>.</p>

                <p>You may fork the Automatic Contract Summarizer by following <a
                        href="https://github.com/devgateway/automatic-contract-summarizer/fork">this
                    link</a>.</p>

                <h2 id="clone-the-fork">Clone the fork</h2>

                <p>After creating the fork, you must copy it locally in order to work. This is called cloning.</p>

                <p>Follow <a
                        href="https://docs.github.com/en/get-started/quickstart/contributing-to-projects#cloning-a-fork">these
                    steps</a> to produce a clone on your computer.</p>

                <h2 id="making-and-pushing-changes">Making and pushing changes</h2>

                <p>On the local cloned repository, you can change the code and make the required changes in similar way
                    as described <a
                            href="https://docs.github.com/en/get-started/quickstart/contributing-to-projects#making-and-pushing-changes">here</a>.
                </p>

                <h2 id="making-a-pull-request">Making a pull request</h2>

                <p>A pull request is the final step in adding back your contribution to our code. Again, the Github
                    contributing guide
                    <a href="https://docs.github.com/en/get-started/quickstart/contributing-to-projects#making-a-pull-request">describes
                        how you can achieve that</a>.</p>


            </div>
        </div>
    </section>
</main>
<footer>
    <div class="container small">
        <img src="assets/dg_logo.jpg" alt="Development Gateway" class="footer-logo">
        <img src="assets/HC2.png" alt="Hackcorruption" class="footer-logo">
    </div>
</footer>
<script src="assets/main.js"></script>
</body>
</html>