Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 2 additions & 3 deletions src/dev-guides/branch-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ metaDesc: Description of branch naming convention used by Pressbooks for its pub
---
We use the following branch naming conventions for pressbooks/pressbooks and other public repositories that we maintain:

- **dev** is a general-purpose work-in-progress branch and the default branch for our repositories. All PRs should be opened against `dev` and must pass our CI/CD pipeline and all coding standards before they are merged. When changes to the `dev` branch for a given repo have been fully tested and determined ready for release, commits are pushed/merged from this branch to `production`.
- **production** is a stable branch. You'll find it running on all our hosted networks and reflected in our latest tagged releases.
- **dev** is a general-purpose work-in-progress branch and the default branch for our repositories. All PRs should be opened against `dev` and must pass our CI/CD pipeline and all coding standards before they are merged. When changes to the `dev` branch for a given repo have been fully tested and determined ready for release, a [new release](https://github.com/pressbooks/reusable-workflows/blob/main/.github/workflows/prepare-release.yml) is tagged and created.
- Any other branches you find are for feature development prior to merging into `dev`. Use at your own risk.
- [Tags](https://github.com/pressbooks/pressbooks/tags) represent releases. If you are downloading a release for installation, you should typically download the package package (e.g. `pressbooks-6.6.0.zip`) from a repository's release list (e.g. [https://github.com/pressbooks/pressbooks/releases/](https://github.com/pressbooks/pressbooks/releases/)) as opposed to the source code.
- [Tags](https://github.com/pressbooks/pressbooks/tags) represent releases. If you are downloading a release for installation, you should typically download the package package (e.g. `pressbooks-6.6.0.zip`) from a repository's release list (e.g. [https://github.com/pressbooks/pressbooks/releases/](https://github.com/pressbooks/pressbooks/releases/)) as opposed to the source code.
4 changes: 2 additions & 2 deletions src/dev-guides/coding-standards.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Bonus: You can sometimes automatically fix errors by running:

## Pressbooks Coding Standards (Mandatory)

We enforce [Human Made Coding Standards](https://github.com/humanmade/coding-standards) with the following small tweaks.
We enforce [Human Made Coding Standards](https://github.com/humanmade/coding-standards) with the following small tweaks:

- Use `camelCase` for class methods & properties, `UPPERCASE` for class constants, `snake_case` everywhere else.
- We do not strictly enforce commenting requirements.
Expand All @@ -42,4 +42,4 @@ Prefix WP User meta keys with `pb_`.

Prefix WP Option names with `pressbooks_`.

Theme files are exempt from the above rules, but should still make an effort to follow them.
Theme files are exempt from the above rules, but should still make an effort to follow them.
Loading