mirror of
https://github.com/vale981/apheleia
synced 2025-03-04 09:01:42 -05:00
Link to contributor guide
This commit is contained in:
parent
91df7b9d19
commit
bd61b7204d
3 changed files with 7 additions and 24 deletions
|
@ -1 +1,2 @@
|
||||||
((nil . ((compile-command . "make lint"))))
|
((nil . ((compile-command . "make lint")
|
||||||
|
(fill-column . 70))))
|
||||||
|
|
8
.github/pull_request_template.md
vendored
8
.github/pull_request_template.md
vendored
|
@ -1,10 +1,8 @@
|
||||||
<!--
|
<!--
|
||||||
|
|
||||||
Checklist:
|
To expedite the pull request process, please see the contributor guide
|
||||||
- [ ] Make sure CI passes: 'make lint'
|
for my projects:
|
||||||
- [ ] If adding new feature, document in README
|
|
||||||
- [ ] If changing user-visible behavior, note in CHANGELOG
|
|
||||||
|
|
||||||
If you're not sure about the approach for your change, feel free to wait on documenting it until after review :)
|
<https://github.com/raxod502/contributor-guide>
|
||||||
|
|
||||||
-->
|
-->
|
||||||
|
|
20
README.md
20
README.md
|
@ -105,24 +105,8 @@ The following user options are also available:
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Development of Apheleia happens using the provided Makefile. Run `make
|
Please see [the contributor guide for my
|
||||||
help` for documentation. All commits are automatically tested using
|
projects](https://github.com/raxod502/contributor-guide).
|
||||||
`make lint` for all supported Emacs versions on the excellent
|
|
||||||
[CircleCI](https://circleci.com/) platform. Please make sure you can
|
|
||||||
successfully run `make lint` before submitting a pull request.
|
|
||||||
|
|
||||||
If the CI fails, it may be that your change is not compatible with one
|
|
||||||
of the Emacs versions supported by Apheleia. Suppose that the failure
|
|
||||||
is for Emacs 25.3. To test this locally, you can install
|
|
||||||
[Docker](https://www.docker.com/) and run:
|
|
||||||
|
|
||||||
% make docker VERSION=25.3
|
|
||||||
|
|
||||||
This will start a shell inside of Docker with the specified version of
|
|
||||||
Emacs available. The Apheleia source code on your filesystem is
|
|
||||||
synchronized with the filesystem inside of Docker, so you need not
|
|
||||||
restart the shell after making changes. To test, simply use the same
|
|
||||||
Makefile targets as usual.
|
|
||||||
|
|
||||||
## Acknowledgements
|
## Acknowledgements
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue