Git Product home page Git Product logo

vale-plain-language-guidelines's Introduction

I archived this repository, because I don't want to work on this project anymore.

Vale Plain Language guidelines

Vale linter code for the Plain Language guidelines.

License

The Vale code is based on the content from the plainlanguage.gov website, which has this license:

You may use any of the content on this site without explicit permission. As a federal website, the content is in the public domain. We ask only that you credit our work by citing back to PLAIN and www.plainlanguage.gov.

vale-plain-language-guidelines's People

Contributors

honkinggoose avatar renovate[bot] avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

vale-plain-language-guidelines's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

  • chore(deps): lock file maintenance

Pending Status Checks

These updates await pending status checks. To force their creation now, click the checkbox below.

  • chore(deps): update dependency prettier to v2.8.8
  • chore(deps): update dependency semantic-release to v20.1.3
  • chore(deps): update dependency semantic-release to v21

Detected dependencies

github-actions
.github/workflows/dependency-review.yml
  • actions/checkout v3.5.2@8e5e7e5ab8b370d6c329ec480221332ada57f0ab
  • actions/dependency-review-action v3.0.4@f46c48ed6d4f1227fb2d9ea62bf6bcbed315589e
.github/workflows/prettier.yml
  • actions/checkout v3.5.2@8e5e7e5ab8b370d6c329ec480221332ada57f0ab
  • actions/setup-node v3.6.0@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c
.github/workflows/release.yml
  • actions/checkout v3.5.2@8e5e7e5ab8b370d6c329ec480221332ada57f0ab
  • actions/setup-node v3.6.0@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c
npm
package.json
  • @semantic-release/exec 6.0.3
  • conventional-changelog-conventionalcommits 5.0.0
  • husky 8.0.3
  • prettier 2.8.4
  • semantic-release 20.1.1

  • Check this box to trigger a request for Renovate to run again on this repository

Checklist after move to `renovatebot` organization

Todo:

  • Check references to HonkingGoose and honkinggoose, and update them if needed
  • Update branch protection rules for main
  • Check bot configuration
  • Check Renovate bot configuration (renovate.json)
  • Extend Renovate bot config from renovatebot/.github
  • Setup GitHub Merge Queue so it works with this repository
  • Check permissions
  • Invite collaborators
  • Add more CODEOWNERS
  • Check CI files
  • Check permissions on CI files
  • Check GitHub App integrations

Create forms

Todo:

  • Bug report form
  • Feature requests form
  • Refactoring form

Base forms on the style we use for renovatebot/renovate repository.

Create `CONTRIBUTING.md` file

Describe the proposed change(s).

Once this project is a state that we can accept outside contributions, we should create a CONTRIBUTING.md file that describes:

  • How to get started
  • Explain that Gitpod and GitHub codespaces are easiest to start with
  • Explain how to run linters
  • Explain how to run tests
  • Any guidelines for behavior

Licensing

The plain language guidelines are licensed under public domain. Our license should be compatible.

Todo:

  • Wait until we publish with semantic-release
  • Move repository to renovate organization
  • Figure out how to license our project
  • Figure out how to license the vale linter code (the main thing that we're actually publishing)
  • Update package.json fields with new license
  • Create LICENSE file in the root of the repo

Release with semantic release bot

We should automate creating a new release by using the Semantic Release bot, like we're doing on the Renovate bot repository already.

Todo:

  • Ask for help, see discussion semantic-release/semantic-release#2466
  • Create .releaserc file that holds semantic-release config
  • Install exec plugin
  • Configure github plugin to list directory in assets list
  • Add exec plugin to config
  • Drop any npm plugin
  • semantic-release should create a .zip of the plain-language-guidelines folder and attach it to each release
  • Start from v1.0.0 (starting from v0.0.0 is not supported by semantic-release)

Write tests to check Vale code

Todo:

  • Wait until I've setup semantic-release and verified package behavior
  • Setup Jest
  • Write starter test
  • Write more tests
  • Create Github action that runs on main and incoming PRs
  • Update branch protection rules for main
  • Make sure semantic-release only releases when all tests pass

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.