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: CONTRIBUTING.md
+34-19Lines changed: 34 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,11 +5,16 @@ Thank you for investing your time in contributing to our projects!
5
5
<!-- do we have a Code of Conduct? What are the general rules of contribution? First issue and discussion?
6
6
Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable. -->
7
7
8
-
In this guide you will get an overview how you can contribute to our projects by opening an issue, creating, reviewing and merging a pull request.
8
+
In this guide you will get an overview how you can contribute to our projects by opening an issue, creating, reviewing
9
+
and merging a pull request.
10
+
11
+
Use the table of contents icon in the top right corner of this document to get to a specific section of this guide
12
+
quickly.
9
13
10
14
## Reporting a security vulnerability
11
15
12
-
Please do not report vulnerabilities and security incidents as GitHub issues. Please contact us by sending an E-Mail to TODO or report them using the contact form at https://fachportal.gematik.de/kontaktformular.
16
+
Please do not report vulnerabilities and security incidents as GitHub issues. Please report them using the contact form
17
+
at https://fachportal.gematik.de/kontaktformular.
13
18
14
19
## New contributor guide
15
20
@@ -26,18 +31,13 @@ If a related issue doesn't exist, you can open a new issue.
26
31
27
32
#### Solve an issue
28
33
29
-
Scan through our existing issues to find one that interests you. If you find an issue to work on, you are welcome to open a PR with a fix.
34
+
Scan through our existing issues to find one that interests you. If you find an issue to work on, you are welcome to
35
+
open a PR with a fix.
30
36
31
37
### Coding Style
32
38
33
-
gematik projects follow the [google style guide](https://github.com/google/styleguide) conventions. Please follow them when working on your contributions.
34
-
35
-
### Code Coverage, Sonars, OWASP, Code format, etc.
36
-
37
-
-
38
-
-
39
-
-
40
-
39
+
gematik projects follow the [google style guide](https://github.com/google/styleguide) conventions. Please follow them
40
+
when working on your contributions.
41
41
42
42
### Commit your update
43
43
@@ -46,20 +46,35 @@ Commit the changes once you are happy with them.
46
46
### Pull Request Process
47
47
48
48
- When you're finished with the changes, create a pull request, also known as a PR.
49
-
- Fill the pull request template so that we can review your PR. This template helps reviewers to understand your changes as well as the purpose of your pull request.
50
-
- Don't forget to [link the PR to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one.
51
-
- Update the [README.adoc](./README.adoc), the documentation and the [ReleaseRotes.md](./ReleaseNotes.md) with all details to document the changes made by this PR.
49
+
- To open a PR
50
+
please [fork the repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
51
+
When you are making changes, it is recommended that you create
52
+
a [new branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)
53
+
for this purpose, based off of the main branch. After your changes are pushed back to your forked
54
+
repository, you can then create a pull request from there.
55
+
- Fill the pull request template so that we can review your PR. This template helps reviewers to understand your changes
56
+
as well as the purpose of your pull request.
57
+
- Don't forget
58
+
to [link the PR to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)
59
+
if you are solving one.
60
+
- Update the [README.adoc](./README.adoc), the documentation and the [ReleaseNotes.md](./ReleaseNotes.md) with all
61
+
details to document the changes made by this PR.
52
62
- Increase the version numbers in any necessary files and the [readme](./README.adoc) to the new version that this
53
63
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
54
-
- Once you submit your PR, a project team member will review your proposal. We may ask questions or request additional information.
55
-
- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request)
56
-
or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
57
-
- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
64
+
- Once you submit your PR, a project team member will review your proposal. We may ask questions or request additional
65
+
information.
66
+
- We may ask for changes to be made before a PR can be merged, either
67
+
using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request)
68
+
or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in
69
+
your fork, then commit them to your branch.
70
+
- As you update your PR and apply changes, mark each conversation
71
+
as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
58
72
- You may merge the Pull Request in once you have the sign-off of two other developers, or if you
59
73
do not have permission to do that, you may request the second reviewer to merge it for you.
60
74
61
75
### Your PR is merged!
62
76
63
77
Congratulations :tada::tada: The gematik team thanks you :sparkles:.
64
78
65
-
Once your PR is merged, your contributions will be publicly visible on the [gematik github page](https://github.com/gematik/).
79
+
Once your PR is merged, your contributions will be publicly visible on
80
+
the [gematik github page](https://github.com/gematik/).
0 commit comments