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
+12-2Lines changed: 12 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,8 +11,7 @@ information to effectively respond to your bug report or contribution.
11
11
12
12
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
13
13
14
-
When filing an issue, please check [existing open](https://github.com/awslabs/git-secrets/issues), or [recently closed](https://github.com/awslabs/git-secrets/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
15
-
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
14
+
When filing an issue, please check [existing open](https://github.com/awslabs/git-secrets/issues), or [recently closed](https://github.com/awslabs/git-secrets/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
16
15
17
16
* A reproducible test case or series of steps
18
17
* The version of our code being used
@@ -21,6 +20,7 @@ reported the issue. Please try to include as much information as you can. Detail
21
20
22
21
23
22
## Contributing via Pull Requests
23
+
24
24
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
25
25
26
26
1. You are working against the latest source on the *master* branch.
@@ -41,16 +41,26 @@ GitHub provides additional document on [forking a repository](https://help.githu
41
41
42
42
43
43
## Finding contributions to work on
44
+
44
45
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels ((enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/awslabs/git-secrets/labels/help%20wanted) issues is a great place to start.
45
46
46
47
48
+
## Testing
49
+
50
+
We use [bats-core](https://github.com/bats-core/bats-core) for testing. It is configured as a submodule of this repository, which will be checked out automatically by `make test` if necessary.
51
+
52
+
New functionality should include new tests. The existing tests in `test/*.bats` can be used as examples.
53
+
54
+
47
55
## Code of Conduct
56
+
48
57
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
49
58
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
50
59
opensource-codeofconduct@amazon.com with any additional questions or comments.
51
60
52
61
53
62
## Security issue notifications
63
+
54
64
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
0 commit comments