Skip to content

Commit

Permalink
Link to contributor guide
Browse files Browse the repository at this point in the history
  • Loading branch information
raxod502 committed May 3, 2020
1 parent 91df7b9 commit bd61b72
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 24 deletions.
3 changes: 2 additions & 1 deletion .dir-locals.el
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
((nil . ((compile-command . "make lint"))))
((nil . ((compile-command . "make lint")
(fill-column . 70))))
8 changes: 3 additions & 5 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
<!--
Checklist:
- [ ] Make sure CI passes: 'make lint'
- [ ] If adding new feature, document in README
- [ ] If changing user-visible behavior, note in CHANGELOG
To expedite the pull request process, please see the contributor guide
for my projects:
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 changes: 2 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,24 +105,8 @@ The following user options are also available:

## Contributing

Development of Apheleia happens using the provided Makefile. Run `make
help` for documentation. All commits are automatically tested using
`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.
Please see [the contributor guide for my
projects](https://github.com/raxod502/contributor-guide).

## Acknowledgements

Expand Down

0 comments on commit bd61b72

Please sign in to comment.