Skip to content
This repository has been archived by the owner on Dec 25, 2023. It is now read-only.

Fix typos #3

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix typos #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ This repository is a collection of `git subtree`s for published LFE books.

Please do not issue pull requests against this repo, as it is essentially read-only.

Acutal book content is mainted in Markdown files in `builder` branches (see the repositories linked below). Content is generated in `master` branches. Pull requests need to be issued against the Markdown files in the `builder` branches below.
Actual book content is maintained in Markdown files in `builder` branches (see the repositories linked below). Content is generated in `master` branches. Pull requests need to be issued against the Markdown files in the `builder` branches below.

Any feedback, bugs, requests, etc., should be filed against the appropriate book in the links below.

Developers and contributers should scroll to the bottom of this file to read instructions on how to incorporate and publish changes to the LFE books.
Developers and contributors should scroll to the bottom of this file to read instructions on how to incorporate and publish changes to the LFE books.

---

Expand Down Expand Up @@ -49,20 +49,20 @@ Developers and contributers should scroll to the bottom of this file to read ins
# Developer / Contributor Notes

1. To update a book, visit the repository for that book (linked above).
1. For the repository, and clone to your machine.
1. Clone the repository to your machine.
1. Create a branch for your change, commit, and push to your fork.
1. Issue a PR against the book publisher's repository for the book.

At this point, a reviewer will examine the change, provide feedback, and iterate with you on any needed changes.

Once approved, the changes will be merged to the `builder` branch and the reviewer will publish these changes to `master`.

Then the reviewer will update the `master` branch that collects all publised LFE books ([https://github.com/lfe/books](https://github.com/lfe/books)) and push that up to Github, at which point you changes will show up for the given book.
Then the reviewer will update the `master` branch that collects all published LFE books ([https://github.com/lfe/books](https://github.com/lfe/books)) and push that up to GitHub, at which point your changes will show up for the given book.

# Reviewer Notes

When adding a new book to the repo, be sure to run `make` first: this will remind you of the steps needed (i.e., updates to the `Makefile` and `README`).

Once those changes are made, to add the actual content for a new book, run `make init-YOUR-BOOK`.

To publish any changes made upstream (e.g., after the merging of a pull request), be sure to run `make publish` in your working directoy of this project. After that, the latest version of all books will be published.
To publish any changes made upstream (e.g., after the merging of a pull request), be sure to run `make publish` in your working directory of this project. After that, the latest version of all books will be published.