|
1 | | -## Add contents in diagram |
2 | | -1. fork this repo |
3 | | -2. open DevSecOps.xml using [draw.io](draw.io) |
4 | | -``` |
5 | | -1) File > Open(Import) from > Devices |
6 | | -2) Open DevSecOps.xml |
7 | | -``` |
8 | | -3. Edit contents |
9 | | -4. Save diagram(xml file) and Export image |
10 | | -``` |
11 | | -1) File > Export as > png |
12 | | -``` |
13 | | -5. Commit/Push the `DevSecOps.xml` and `DevSecOps.png` files to the your forked repository. |
14 | | -6. Make and Send PR(Pull Request) |
15 | | - |
16 | | -## Add contents in README |
17 | | -Please add content and send us PR! |
18 | | -1. fork this repo |
19 | | -2. Edit contents from forked repo |
20 | | -3. Make and Send PR(Pull Request) |
21 | | - |
22 | | -## Add tools |
23 | | -1. form this repo |
24 | | -2. clone forked repo |
25 | | -``` |
26 | | -$ git clone https://github.com/{your}/DevSecOps |
27 | | -``` |
28 | | -3. build contribute tools |
29 | | -``` |
30 | | -$ cd DevSecOps/tools |
31 | | -$ make contribute |
32 | | -``` |
33 | | -4. Add tool with `./add-tool` |
34 | | -``` |
35 | | -$ ./add-tool -url https://github.com/zaproxy/zaproxy |
36 | | -``` |
37 | | -5. Distribute README.md with `./distribute-readme` |
38 | | -``` |
39 | | -$ ./distribute-readme |
40 | | -``` |
41 | | -6. commit and push `data.json` and `README.md` |
42 | | -``` |
43 | | -$ git add data.json README.md ; git commit -m "commit and push" ; git push |
44 | | -``` |
45 | | -7. Make and Send PR(Pull Request) |
| 1 | +# Contributing to DevSecOps |
| 2 | + |
| 3 | +Thank you for your interest in contributing to our DevSecOps project! This document provides guidelines for different types of contributions. |
| 4 | + |
| 5 | +## Table of Contents |
| 6 | +- [Updating the DevSecOps Diagram](#updating-the-devsecops-diagram) |
| 7 | +- [Contributing to the Documentation](#contributing-to-the-documentation) |
| 8 | +- [Adding Tools to the Repository](#adding-tools-to-the-repository) |
| 9 | +- [Creating a Pull Request](#creating-a-pull-request) |
| 10 | + |
| 11 | +## Updating the DevSecOps Diagram |
| 12 | + |
| 13 | +1. Fork this repository to your GitHub account. |
| 14 | +2. Open the diagram file using [draw.io](https://draw.io): |
| 15 | + - Select **File > Open from > Device** |
| 16 | + - Choose the `DevSecOps.xml` file from your forked repository |
| 17 | +3. Make your desired edits to the diagram. |
| 18 | +4. Save both the XML source and export a PNG image: |
| 19 | + - Save the XML: **File > Save** or **File > Save As** |
| 20 | + - Export as PNG: **File > Export as > PNG** |
| 21 | +5. Commit both the updated `DevSecOps.xml` and `DevSecOps.png` files to your forked repository. |
| 22 | +6. Create a Pull Request (see [Creating a Pull Request](#creating-a-pull-request) section). |
| 23 | + |
| 24 | +## Contributing to the Documentation |
| 25 | + |
| 26 | +1. Fork this repository to your GitHub account. |
| 27 | +2. Make your changes to the README.md or other documentation files. |
| 28 | +3. Create a Pull Request with your improvements. |
| 29 | + |
| 30 | +## Adding Tools to the Repository |
| 31 | + |
| 32 | +1. Fork this repository to your GitHub account. |
| 33 | +2. Clone your forked repository: |
| 34 | + ```bash |
| 35 | + git clone https://github.com/YOUR-USERNAME/DevSecOps |
| 36 | + cd DevSecOps/tools |
| 37 | + ``` |
| 38 | +3. Update the tools directory and corresponding `README.md` file. |
| 39 | +4. Commit and push your changes: |
| 40 | + ```bash |
| 41 | + git add . |
| 42 | + git commit -m "Add/update tools: BRIEF DESCRIPTION" -s |
| 43 | + git push |
| 44 | + ``` |
| 45 | +5. Create a Pull Request (see next section). |
| 46 | + |
| 47 | +## Creating a Pull Request |
| 48 | + |
| 49 | +1. Navigate to your forked repository on GitHub. |
| 50 | +2. Click on "Pull Request" and then "New Pull Request". |
| 51 | +3. Ensure the base repository is the original DevSecOps repository and the head repository is your fork. |
| 52 | +4. Provide a clear title and description for your Pull Request, explaining the changes you've made. |
| 53 | +5. Submit the Pull Request. |
| 54 | + |
| 55 | +Thank you for contributing to make this project better! |
0 commit comments