1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
|
## Reporting issues
Please report bugs to the [issue tracker][issues].
If you're having issue with completion, please include enough
information to reproduce the issue, this usually includes:
* the version of Emacs you're using `emacs -version`
* the version of Bash you're using `bash -version`
* the bash completion script, its version and where to download it from
## Suggesting features
Add feature suggestions to the [issue tracker][issues].
Development isn't very active, so the best way to get a new feature in
is to add it yourself as code or documentation contributions.
## Asking questions
Start a new [discussion][discussions] with your question.
## Documentation contributions
Contribution to the documentation, either the README.md or code
comments are very welcome. Please open a [pull request][pulls] with
your proposed modifications.
## Code contributions
To contribute code to the project, open a [pull request][pulls].
Before you do that, please make sure the any new features is covered
by tests and that the tests pass.
To run the tests, install [eldev], and run the tests with:
```bash
eldev test
```
Tests can also be run from inside Emacs,
using `M-x ert-run-tests-interactively` but when you do so, be aware
that there might be unexpected interaction with your Emacs
configurations; Tests passing when run from Eldev is what matters.
After you've sent your pull request, please check the result of
[GitHub actions][actions] running tests on your pull request. GitHub
actions run the same tests on multiple versions of Emacs and Bash so
is likely to highlight version-specific issues you might not have
noticed when running tests on your machine.
For larger features, it's a good idea to first open an
[issue][issues] that describes the feature and mention that you're
thinking about working on it. This gives an opportunity to discuss the
new feature and its possible implementations.
[eldev]: https://emacs-eldev.github.io/eldev/
[issues]: https://github.com/szermatt/emacs-bash-completion/issues
[discussions]: https://github.com/szermatt/emacs-bash-completion/discussions
[actions]: https://github.com/szermatt/emacs-bash-completion/actions
[pulls]: https://github.com/szermatt/emacs-bash-completion/pulls
|
