Skip to content
This repository was archived by the owner on Oct 14, 2020. It is now read-only.

Commit b5d9657

Browse files
committed
[WIP] Update CONTRIBUTING
1 parent de9a874 commit b5d9657

File tree

1 file changed

+20
-17
lines changed

1 file changed

+20
-17
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,8 @@
11
# Contributing
22

3-
There are multiple different workflows with different advantages and disadvantages.
4-
The most common workflows are:
3+
## GitHub Flow
54

6-
- [GitFlow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)
7-
- [GitHub Flow](https://githubflow.github.io/)
8-
- [GitLab Flow](https://about.gitlab.com/blog/2014/09/29/gitlab-flow/)
9-
10-
## GitHub Flow (How we want to work)
5+
For more information see [GitHub Flow](https://githubflow.github.io/)
116

127
GitHub Flow is very lightweight (especially compared to GitFlow).
138
This workflow uses only two kinds of branches:
@@ -23,7 +18,7 @@ The `main` branch is expected to be deployed regularly and is considered stable.
2318

2419
### How to work with GitHub Flow
2520

26-
For more Information see [GitHub Flow](https://githubflow.github.io/)
21+
For more information see [GitHub Flow](https://githubflow.github.io/)
2722

2823
TL;DR
2924

@@ -34,22 +29,20 @@ TL;DR
3429
5. merge only after pull request review
3530
6. deploy immediately after review
3631

37-
### Why not GitLab Flow or GitFlow
38-
39-
Both `GitLab Flow` and `GitFlow` are to complex for our use case.
40-
41-
## Working with The Community / Working with Forks
32+
## Working with Forks and Pull Requests
4233

4334
Our current continuous integration workflow makes it very hard to work on own forks of the SecureCodeBox because CI tests cannot be executed outside of our repository. We are aware of that problem and are working on a solution.
4435

45-
## Working with Issues
36+
Generally the SCB project follows the standard [GitHub Pull request process](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests).
4637

47-
`GitHub Flow` does not enforce you to use Issues but it is highly encouraged.
48-
It is recommended to use an Issue for every Task taking longer than 1h (See [GitLab Flow](https://about.gitlab.com/blog/2014/09/29/gitlab-flow/)).
38+
## Working with Issues / How to Contribute in Issues
39+
40+
For every task taking more than 1h, opening an issue is required.
41+
Before opening an Issue please verify there is no existing one covering your issue.
4942

5043
## How to Write Commit Messages
5144

52-
For more Information see [here](https://chris.beams.io/posts/git-commit/).
45+
For more information see [here](https://chris.beams.io/posts/git-commit/).
5346

5447
TL;DR
5548

@@ -60,3 +53,13 @@ TL;DR
6053
5. Use the imperative mood in the subject line
6154
6. Wrap the body at 72 characters
6255
7. Use the body to explain what and why vs. how
56+
57+
NOTE: Make sure you don't include `@mentions` or `fixes` keywords in your git commit messages. These should be included in the PR body instead.
58+
59+
## Code Review
60+
61+
## Code of Conduct
62+
63+
## Code Style
64+
65+

0 commit comments

Comments
 (0)