Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 3.5 KB

CONTRIBUTING.md

File metadata and controls

54 lines (37 loc) · 3.5 KB
Raw

Contributing

woke is an Open Source project that started when I realized there weren't any OSS tools to catch insensitive and non-inclusive language within source code.

By participating in this project, you agree to abide by this projects Code Of Conduct.

woke is essentially a language-agnostic linter. I've taken my favorite parts of other linters and used that as a guiding force.

Rules

A few rules for when contributing to this project:

  • The goal of this project is to identify places within text files where better, inclusive language can be used. Please don't make contributions that don't push this goal forward.
  • This project is not the forum to determine what is inclusive language and what is insensitive language. Contributions should be limited to providing consumers of woke the ability to make their own decisions regarding conscious language.
  • You will participate in discussions that embody the spirit of this project and work towards building a healthy, supportive, and productive culture, and an environment where everyone feels welcome and included.
  • If you're adding linter-based features, try to link to other well-known linters as a reference for why you want the feature added and what benefit it provides.
  • Programming language-specific changes should be avoided at all costs. Please keep this project programming language-agnostic.

If you do not abide by these rules, this is your only warning and you will be blocked and reported immediately if I find your contributions do not embody the spirit of the project.

How to contribute

  1. Fork, then clone the repo:

     git clone git@github.com:your-username/woke.git

  2. Setup (Dev Container)

    1. Add VS Code Remote Container Extension
    2. Remote-Containers: Open Folder in Container... command from the Command Palette (F1) or quick actions Status bar item on the bottom left of VS Code

  3. Or Setup (Manual)

    1. Install go
    2. Install pre-commit and run pre-commit install
    3. Install required packages for pre-commit (there might be more, here are a few... see pre-commit-config.yaml)
      1. go install github.com/fzipp/gocyclo
      2. go install golang.org/x/tools/cmd/goimports
      3. golangci-lint

  4. Make your changes and add tests for your change. Make sure tests pass

     go test ./...

  5. Push to your fork and submit a pull request. Fill out the Pull Request template thoroughly. I expect contributions to be thoughtful, have tests that are meaningful, and to be considerate of others who use this tool.

At this point you're waiting on the maintainers. Since this is a personal project, I make no guarantees on response time, but I will do my absolute best because I care about this tool. I may suggest some changes or improvements or alternatives and reserve the right to reject your contribution if I find it does not promote the spirit of this project.

Some things that will increase the chance that your pull request is accepted: