diff options
| author | Radon Rosborough <radon.neon@gmail.com> | 2020-05-03 08:30:02 -0600 |
|---|---|---|
| committer | Radon Rosborough <radon.neon@gmail.com> | 2020-05-03 08:30:02 -0600 |
| commit | bd61b7204d97a6f3dc410222d63926382d605462 (patch) | |
| tree | 161658a4562228cd390aa9ede4c29e50c05a93bb | |
| parent | 91df7b9d19f85794b1e7d8b03aef290cd2b9699d (diff) | |
Link to contributor guide
| -rw-r--r-- | .dir-locals.el | 3 | ||||
| -rw-r--r-- | .github/pull_request_template.md | 8 | ||||
| -rw-r--r-- | README.md | 20 |
3 files changed, 7 insertions, 24 deletions
diff --git a/.dir-locals.el b/.dir-locals.el index 8633aff..5cec739 100644 --- a/.dir-locals.el +++ b/.dir-locals.el @@ -1 +1,2 @@ -((nil . ((compile-command . "make lint")))) +((nil . ((compile-command . "make lint") + (fill-column . 70)))) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 7156fc4..2bb734b 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -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> --> @@ -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 |