• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!--
2Hello, and thank you for submitting a pull request to nom!
3
4First, please note that, for family reasons, I have limited time to work on
5nom, so following the advice here will make sure I will quickly understand
6your work and be able to merge it early.
7Second, if I don't get to work on your PR quickly, that does not mean I won't
8include it later. Major version releases happen once a year, and a lot of
9interesting work is merged for the occasion. So I will get back to you :)
10
11## Prerequisites
12
13Please provide the following information with this pull request:
14
15- related issue number (I need some context to understand a PR with a lot of
16code, except for documentation typos)
17- a test case reproducing the issue. You can write it in [issues.rs](https://github.com/Geal/nom/blob/main/tests/issues.rs)
18- if adding a new combinator, please add code documentation and some unit tests
19in the same file. Also, please update the [combinator list](https://github.com/Geal/nom/blob/main/doc/choosing_a_combinator.md)
20
21## Code style
22
23This project follows a [code style](https://github.com/Geal/nom/blob/main/rustfmt.toml)
24checked by [rustfmt][https://github.com/rust-lang-nursery/rustfmt].
25
26Please avoid cosmetic fixes unrelated to the pull request. Keeping the changes
27as small as possible increase your chances of getting this merged quickly.
28
29## Rebasing
30
31To make sure the changes will work properly once merged into the main branch
32(which might have changed while you were working on your PR), please
33[rebase your PR on main](https://git-scm.com/book/en/v2/Git-Branching-Rebasing).
34
35## Squashing the commits
36
37If the pull request include a lot of small commits used for testing, debugging,
38or correcting previous work, it might be useful to
39[squash the commits](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History)
40to make the code easier to merge.
41-->
42