v/.github/PULL_REQUEST_TEMPLATE

29 lines
699 B
Plaintext
Raw Normal View History

2019-06-26 13:53:42 +02:00
Please title your PR as follows: `time: fix foo bar`. Always start with the thing you are fixing, then describe the fix.
2019-06-26 15:54:58 +02:00
Don't use past tense (e.g. "fixed foo bar").
2019-06-26 13:42:56 +02:00
Explain what your PR does and why.
2019-06-26 13:39:38 +02:00
2019-06-29 16:50:13 +02:00
If you are adding a new function, please document it and add tests:
```
// foo does foo and bar
fn foo() {
// file_test.v
fn test_foo() {
assert foo() == ...
...
}
```
2019-06-26 13:42:56 +02:00
Before submitting a PR, please run the tests with `make test`, and make sure V can still compile itself. Run this twice:
2019-06-26 13:39:38 +02:00
./v -o v compiler
./v -o v compiler
2019-06-26 13:39:38 +02:00
2019-06-26 13:53:42 +02:00
I try to process PRs as soon as possible. They should be handled within 24 hours.
2019-06-26 16:43:12 +02:00
Applying labels to PRs is not needed.
2019-06-26 13:39:38 +02:00
Thanks a lot for your contribution!