Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
Signed-off-by: Psionik K <[email protected]>
  • Loading branch information
psionic-k committed Oct 21, 2023
1 parent 041c6f7 commit e8da237
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 4 deletions.
18 changes: 15 additions & 3 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@
separate commit for the reviewer. Title your commit as "generated".

Keeping these changes isolated in specific commits makes it much easier to pull
in your changes in parallel with other features. Maintainers may harvest your
changes. We only guarantee to preserve authorship, signature, and sign-off in
the git log.
in your changes in parallel with other features.

Maintainers may harvest your changes. We only guarantee to preserve authorship,
signature, and sign-off in the git log.

### Creating pull requests

Expand All @@ -18,3 +19,14 @@ the git log.
checkbox)
1. Once the pull request has been approved, you will be thanked and observe your
changes applied with authorship, signature, and sign-off in the git log

### Reminder about PR access to upstream CI

Pull-requests run with the `pull_request_target` Github Actions configuration.
Your PR can access secrets, but it run's the **upstream's** CI, not the CI
changes you are submitting.

If you need to make changes to CI itself in order to pass checks, you will need
to work with the repository's owner. The owner will pull the branch into a
non-master branch. There, they can trigger the CI manually with the branch's
own configuration using `workflow_dispatch` in the Actions tab.
29 changes: 28 additions & 1 deletion docs/README.org
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,37 @@
<a href="https://github.com/positron-solutions/elisp-repo-kit/actions/?workflow=Developer+Certificate+of+Origin"><img src="https://github.com/positron-solutions/elisp-repo-kit/actions/workflows/dco.yml/badge.svg" alt="DCO Check"></a>
#+end_export

#+include: "manual.org::*Use with Elisp Repo Kit"
* Elisp Repository Kit Basic

#+include: "manual.org::*Use with Elisp Repo Kit" :only-contents t

* Install Elisp repository kit basic

#+begin_src elisp

;; update this after you publish your new package!
;; (use-package erk-basic) ; vanilla, assuming you have MELPA configured

;; using elpaca's with explicit recipe
(use-package erk-basic
:elpaca (erk-basic :host github :repo "positron-solutions/erk-basic"))

;; straight with explicit recipe
(use-package erk-basic
:straight (erk-basic :type git :host github :repo "positron-solutions/erk-basic"))

;; or use manual load-path & require, you brave yak shaver

#+end_src

#+toc: headlines 2

* Contributing

Because this repository is created from [[https://github.com/positron-solutions/elisp-repo-kit][elisp-repo-kit]], please file any issues
or make relevant pull requests there unless the changes are specific to this
repo.

See the [[../CONTRIBUTING.md][CONTRIBUTING]] guide for help making changes to this project.

For turn-key contribution to the software ecosystem that keeps you moving, see
Expand Down

0 comments on commit e8da237

Please sign in to comment.