Skip to content

How to contribute varies, make documentation more precise #1121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wenkokke merged 2 commits into from
Jul 27, 2025
Merged

How to contribute varies, make documentation more precise #1121

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c377421
document how contributing should work for people external to PLFA org…
JacquesCarette Jul 26, 2025
c728bb4
document that you will be given a link URL to create a PR
JacquesCarette Jul 26, 2025
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
12 changes: 11 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,17 @@ make test-epubcheck # Tests the generated EPUB using EPUBCheck

## How to make changes to PLFA

The `dev` branch of the repository is write-protected, meaning that changes can only be made via pull requests, once all tests have passed. To make changes, create a new branch by running the following command from your local copy of the repository:
The `dev` branch of the repository is write-protected, meaning that changes can only be made via pull requests, once all tests have passed.

How to make changes depends on whether you are a member of the plfa organization or not.

### If you are not a member of the plfa organization

First make a fork of the repository. There is a button on the github interface for doing this. Then make a local copy of your fork. Then follow the same instructions (below) as for members. When you perform the `git push`, you will be given a URL with which to make the pull request.

### For members of the plfa organization

Create a new branch by running the following command from your local copy of the repository:

```sh
git checkout -b [new_branch_name] [old_branch_name]
Expand Down
Loading