You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-9Lines changed: 20 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,11 +26,20 @@ There are currently several ways to collaborate:
26
26
3. Forking the repository and creating a pull request to the develop branch
27
27
4. Commenting directly on the deployed version
28
28
29
-
> ⚠️ Please sign and verify every commit.
29
+
> ⚠️ Please sign and verify every commit. If you've accidentally created unsigned
30
+
> commits in your history, you can resolve them by setting up [signature verification](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification#gpg-commit-signature-verification)
31
+
> on github and re-writing your history using the below commands.
32
+
>
33
+
> ```
34
+
> git pull origin develop
35
+
> git reset --soft develop
36
+
> git commit -s -m "Commit Message"
37
+
> git push --force
38
+
> ```
30
39
31
40
### Framework-specific branches
32
41
33
-
Before contributing, check if there's a [Steward](src/contribute/stewards.md) for the specific framework you're interested in, and reach out. We usually have separate branches pre-develop for frameworks with stewards.
42
+
Before contributing, check if there's a [Steward](src/contribute/stewards.md) for the specific framework you're interested in, and reach out. We usually have separate branches pre-develop for frameworks with stewards.
34
43
35
44
The naming convention is `fw_framework_name`, for example `fw_opsec`, `fw_community_mgmt`. Ideally, you'll fork these framework-specific branches, as they typically have more updated information than what's available in the develop branch.
36
45
@@ -49,14 +58,15 @@ To comment on the live version of the book under development, you will need to l
49
58
50
59
1. Fork the repository. Click on the "Fork" button at the top right corner of the page.
51
60
2. Clone the forked repository to your local machine. Open your terminal or command prompt.
3. Check if there's a framework-specific branch you should be working on. If yes, use that branch instead of develop.
54
63
4. Otherwise, make sure you're in the develop branch:
55
-
`git checkout develop`
64
+
`git checkout develop`
56
65
5. Inside the folder create a new branch based on the appropriate branch:
57
-
`git checkout -b your-feature-branch`
66
+
`git checkout -b your-feature-branch`
58
67
6. Make your changes.
59
68
7. If adding new pages, consider adding appropriate tags in the frontmatter. Example:
69
+
60
70
```
61
71
---
62
72
tags:
@@ -66,15 +76,16 @@ tags:
66
76
- SRE
67
77
---
68
78
```
79
+
69
80
8. If adding significant content, add attribution using the contributors system (see [using-contributors.md](src/config/using-contributors.md)).
70
81
9. Make sure your changes don't break anything by testing it in the local setup:
71
-
`./serve.sh`
82
+
`./serve.sh`
72
83
10. Commit your changes:
73
-
`git add .`
84
+
`git add .`
74
85
11. Commit the changes with a descriptive message:
75
-
`git commit -S -m "Fixing typos and improving readability on XXX section"`
86
+
`git commit -S -m "Fixing typos and improving readability on XXX section"`
76
87
12. Push the changes to your forked repository:
77
-
`git push origin your-feature-branch`
88
+
`git push origin your-feature-branch`
78
89
13. Create a pull request. Go to your forked repository on GitHub. You should see a "Compare & pull request" button. Click on it. Provide a descriptive title and description for your pull request.
79
90
14. Click on the "Create pull request" button.
80
91
15. Wait for review. Once your pull request is approved, and no more changes are needed, we will merge it into the appropriate branch.
0 commit comments