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 5a2e577 commit d7444ae
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 30 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))))
11 changes: 10 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1 +1,10 @@
<!-- Please create pull requests against the develop branch only! -->
<!--
To expedite the pull request process, please see the contributor guide
for my projects:
<https://github.com/raxod502/contributor-guide>
Please create pull requests against the develop branch only!
-->
32 changes: 4 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2673,34 +2673,10 @@ branch in any fork:
(setq straight-repository-user "my-github-username")
(setq straight-repository-branch "feat/my-cool-feature")

Please try to follow the style of the surrounding code and
documentation, but anything is welcome. All text, including comments
and docstrings, should be formatted using Emacs' `M-x fill-paragraph`
command (bound to `M-q` by default).

We require that the linting pass on all new commits. You can check
this easily by installing [Docker] and running

$ make docker

Then you will be in a shell with the `straight.el` source code, and to
test your commits you'll be able to run

$ make lint

or to see what other targets are available

$ make help

If you don't want to install Docker, you can simply skip the `make
docker` step, and everything will work the same! However, you'll then
have to make sure you have the relevant dependencies installed
locally.

When you create a pull request, it will be [tested
automatically][circleci-build] on [CircleCI] and the status will be
reported. Please make sure the CI build is passing before asking for
review.
For additional information, please see [the contributor guide for my
projects](https://github.com/raxod502/contributor-guide). Note that
`straight.el` has not yet had an initial release, so you don't have to
worry about a changelog.

## FAQ
### My init time got slower
Expand Down

0 comments on commit d7444ae

Please sign in to comment.