@@ -9,8 +9,10 @@ If you're unsure where to start, we recommend our [`good first issue`](https://g
9
9
## Bug reports and feature suggestions
10
10
11
11
Bug reports and feature suggestions can be submitted to our [ issue tracker] ( https://github.com/trailofbits/vast/issues ) .
12
- For bug reports, attaching the source that caused the bug will help us in
13
- debugging and resolving the issue quickly.
12
+
13
+ When reporting a bug please provide ** a minimal** example with steps to reproduce the issue
14
+ if possible. It helps us a lot, as we can get to the bottom of the issue much faster and can
15
+ even use it as a test case to catch future regressions.
14
16
15
17
## Questions
16
18
@@ -21,12 +23,25 @@ For legal reasons, we require contributors to sign our [Contributor License
21
23
Agreement] ( https://cla-assistant.io/trailofbits/vast ) . This will be
22
24
automatically checked as part of our CI.
23
25
24
- ## Code
26
+ ## Git & Pull Requests
25
27
26
- Manticore uses the pull request contribution model. Please make an account on
28
+ VAST uses the pull request contribution model. Please make an account on
27
29
Github, fork this repo, and submit code contributions via pull request. For
28
30
more documentation, look [ here] ( https://guides.github.com/activities/forking/ ) .
29
31
32
+ Since VAST does not squash commits in a pull request, it is important to uphold
33
+ some culture when it comes to commits.
34
+
35
+ - Commit should ideally be one simple change.
36
+ - Commit messages follow a simple format:
37
+ ` component: Simple sentence with a dot. ` with maximum of 80 chars and optional longer
38
+ message.
39
+ - When unsure what component commit modifies, run ` git log ` on the modified file(s).
40
+ - Commits should modify only one component (as a result the project does not have
41
+ to build with each separate commit)
42
+ - If you are having troubles coming up with a simple sentence as a commit message,
43
+ that is short enough, it may be a good indicator that the commit should be split.
44
+
30
45
Some pull request guidelines:
31
46
32
47
- Minimize irrelevant changes (formatting, whitespace, etc) to code that would
@@ -40,3 +55,5 @@ Some pull request guidelines:
40
55
- Title your pull request with a brief description of what it's changing.
41
56
"Fixes #123 " is a good comment to add to the description, but makes for an
42
57
unclear title on its own.
58
+ - CI must pass for the PR to be merged.
59
+ - There must be a review from some maintainer that accepts changes for the PR to be merged.
0 commit comments