Skip to content

Commit d179a22

Browse files
committed
CONTRIBUTING: Update.
1 parent 2674b1a commit d179a22

File tree

1 file changed

+21
-4
lines changed

1 file changed

+21
-4
lines changed

CONTRIBUTING.md

+21-4
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,10 @@ If you're unsure where to start, we recommend our [`good first issue`](https://g
99
## Bug reports and feature suggestions
1010

1111
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.
1416

1517
## Questions
1618

@@ -21,12 +23,25 @@ For legal reasons, we require contributors to sign our [Contributor License
2123
Agreement](https://cla-assistant.io/trailofbits/vast). This will be
2224
automatically checked as part of our CI.
2325

24-
## Code
26+
## Git & Pull Requests
2527

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
2729
Github, fork this repo, and submit code contributions via pull request. For
2830
more documentation, look [here](https://guides.github.com/activities/forking/).
2931

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+
3045
Some pull request guidelines:
3146

3247
- Minimize irrelevant changes (formatting, whitespace, etc) to code that would
@@ -40,3 +55,5 @@ Some pull request guidelines:
4055
- Title your pull request with a brief description of what it's changing.
4156
"Fixes #123" is a good comment to add to the description, but makes for an
4257
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

Comments
 (0)