Skip to content

Commit

Permalink
style: use sentence case over ap style for titles and headings
Browse files Browse the repository at this point in the history
  • Loading branch information
Fdawgs committed Feb 12, 2023
1 parent 5cc350b commit 4df886d
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 15 deletions.
16 changes: 5 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,33 +13,27 @@ Other processes and specifications that are in use in this repository are:
- [Conventional commits](https://conventionalcommits.org/en/v1.0.0/) following the @commitlint/config-conventional config
- [Prettier](https://prettier.io/) style guide

## Getting Started
## Getting started

This repository requires that you have [Node.js](https://nodejs.org) >=14.0.0 installed.

With that in place, you can fork the repository, clone it, and then run `npm i` to install all dependencies.

### Development Workflow
### Development workflow

After cloning the repository and installing all the dependencies, there are several commands available for local development:

- `npm run lint` - Lints everything in src directory
- `npm run jest` - Runs Jest over all tests in src directory
- `npm test` - Runs `npm run lint` and `npm run jest` together

## Documentation Style
## Documentation style

Documentation (both in markdown files and inline comments) should be written in **British English** where possible.

Titles and headings should adhere to the [Associated Press (AP)](https://apstylebook.com/) style:
Titles and headings should use sentence-style capitalisation, where only the first letter of a sentence and proper nouns are capitalised.

- Capitalise words with three or more letters
- Capitalise the first and the last word
- Capitalise nouns, pronouns, adjectives, verbs, adverbs, and subordinate conjunctions
- Lowercase articles (a, an, the), coordinating conjunctions, and prepositions
- Capitalise words with four or more letters (including conjunctions and prepositions)

## Pull Request Checklist
## Pull request checklist

Before submitting a pull request back to the main repository, please make sure you have completed the following steps:

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Surrogate-Control: no-store

This plugin was created out of a need for an easy way to disable client-side caching for data received from backend APIs. This ensures data is always current when called by applications.

### Why These Headers?
### Why these headers?

- `Cache-Control` - Primary response header for configuring cache controls [since HTTP/1.1](https://httpwg.org/specs/rfc7234.html#header.cache-control); whilst `no-store` is the directive to disable caching, clients such as [Internet Explorer](https://learn.microsoft.com/en-us/troubleshoot/developer/browsers/connectivity-navigation/how-to-prevent-caching#the-cache-control-header) did not use it, thus the addition of `max-age=0, must-revalidate`
- `Expires` - Included for backwards compatibility with [HTTP/1.0 caches](https://w3.org/Protocols/HTTP/1.0/spec.html#Expires)
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Security

## Disclosure Policy
## Disclosure policy

Please email reports about any security-related issues you find to frazer.dev@outlook.com.
Please use a descriptive subject line in your report email, in addition to a reference or link to this repository.
Expand Down
4 changes: 2 additions & 2 deletions src/index.test.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
const Fastify = require("fastify");
const plugin = require(".");

describe("Disablecache Plugin", () => {
describe("Response Headers", () => {
describe("Disablecache plugin", () => {
describe("Response headers", () => {
let server;

beforeAll(async () => {
Expand Down

0 comments on commit 4df886d

Please sign in to comment.