Skip to content
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.

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

docs: split off a CONTRIBUTING.md and improve formatting, grammar, links #313

Merged
merged 2 commits into from May 5, 2022

Commits on May 1, 2022

  1. docs: split off a CONTRIBUTING.md from the README

    - condenses the README a bit and uses the standard CONTRIBUTING.md file
      - it's a file I often look for when filing an issue or creating a PR
      - leaves the section still in the README so that users (esp. on NPM)
        will know to go there if they're not aware of that convention
    
    - GitHub also now tells users to read the CONTRIBUTING.md of a repo when
      filing issues or creating PRs, so hopefully this helps point more
      users in the right direction as well
    agilgur5 committed May 1, 2022
    Configuration menu
    Copy the full SHA
    b8410af View commit details
    Browse the repository at this point in the history

Commits on May 3, 2022

  1. docs: improve formatting, grammar, and links in CONTRIBUTING.md

    - slightly change reference to GH Issue Tracker
    
    - use oxford commas everywhere for clarity
    - missing "the" in a few places
    - more minor grammatical fixes (missing space, semicolon vs. comma, etc)
    
    - fix: "npm_modules" -> "`node_modules`"
    - fix: "npm lint" -> "npm run lint", "npm build" -> "npm run build",
      "npm build-self" -> "npm run build-self"
      - short-hand works in Yarn and for some pre-defined Node scripts, like
        `start` and `test`, but the rest need `run`
    - "typescript" -> "TS" (prefer proper "TypeScript" or just "TS")
    - use backticks monospace/code formatting where appropriate
    
    - link to GitHub's official docs on forking and making PRs
      - also use the word "standard" instead of "normal" as it's more
        inclusive and reflective that this is a convention/standard
    - link to editorconfig site
    - link directly to `.editorconfig` with a relative link as well
    - reword portion about PR checks as they do run `build` and `build-self`
      nowadays (not sure how old this text is)
    
    - use an ordered list (instead of unordered) for the testing process
      as this is meant to be done in order
    agilgur5 committed May 3, 2022
    Configuration menu
    Copy the full SHA
    d92133d View commit details
    Browse the repository at this point in the history