Add guidelines for open source and refactor structure (#8)

Author: BakerNet

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,18 @@
+## Related PR(s)
+
+<!--
+Delete this section if there are no related PRs.
+-->
+
+## Related Issue(s)
+
+<!--
+Delete this section if there is no Issue this PR attempts to resolve or make progress on.
+-->
+
+## Summary / Background
+
+<!--
+Use this section to give a high level overview of the "why" and "what" for your changes.
+-->
+

.github/workflows/covbadge.yml

@@ -22,7 +22,7 @@ jobs:
       run: go install github.com/AlexBeauchemin/[email protected]
 
     - name: 'Run gobadge'
-      run: ./covbadge.sh
+      run: ./scripts/covbadge.sh
 
     - name: 'Fail if not updated'
       run: git diff -U0 --exit-code

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+<[email protected]>.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# CONTRIBUTING.md
+
+## Contributing Guidelines
+
+Thank you for considering contributing to Codeowners Plus! We welcome contributions from the community to improve and expand this project. This document outlines how to get involved.
+
+### How to Contribute
+
+#### Reporting Issues
+* Search existing issues to see if your concern has already been raised.
+* Open a new issue if you find a bug, have a suggestion, or encounter a problem.
+* Provide as much detail as possible, including steps to reproduce the issue and any relevant context.
+
+#### Submitting Changes
+* Fork the repository
+* Create a new branch for your changes
+* After making code changes, run `./scripts/covbadge.sh` to update the code coverage badge (this will be enforced in GHA checks)
+* Commit your changes with clear and descriptive commit messages
+* Push your changes to your fork
+* Open a pull request against the `main` branch of this repository
+
+### Code Style and Standards
+* Follow [Go best practices](https://go.dev/doc/effective_go).
+* Write clear, concise, and well-documented code.
+* Include unit tests for any new functionality.
+
+### Reviewing and Merging Changes
+* All pull requests will be reviewed by maintainers.
+* Address feedback promptly and communicate if additional time is needed.
+* Once approved, your changes will be merged by a maintainer.
+
+### Community
+* Join discussions in the issues section to help troubleshoot or brainstorm solutions.
+* Respectfully engage with others to maintain a friendly and constructive environment.

Dockerfile

@@ -6,6 +6,7 @@ COPY go.mod go.sum ./
 RUN go mod download
 
 COPY main.go .
+COPY pkg ./pkg/
 COPY internal ./internal/
 
 # Statically comple with CGO enabled will be needed if we integrate go-tree-sitter

README.md

@@ -4,21 +4,22 @@ Code Ownership & Review Assignment Tool - GitHub CODEOWNERS but better
 
 [![Go Report Card](https://goreportcard.com/badge/github.com/multimediallc/codeowners-plus?1)](https://goreportcard.com/report/github.com/multimediallc/codeowners-plus)
 [![Tests](https://github.com/multimediallc/codeowners-plus/actions/workflows/go.yml/badge.svg)](https://github.com/multimediallc/codeowners-plus/actions/workflows/go.yml)
-![Coverage](https://img.shields.io/badge/Coverage-63.6%25-yellow)
+![Coverage](https://img.shields.io/badge/Coverage-59.8%25-yellow)
 [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
 
 This tool is meant to be an alternative to [GitHub CODEOWNERS](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners), overcoming limitations with the `CODEOWNERS` spec and GitHub code owners feature.
 
 ## Features
 
 These are features missing from GitHub code owners that are supported by Codeowners Plus
 
-- Smart dismissal of stale reviews (only dismiss review when owned files change, rather than any reviewable push)
-- Supports multiple owners of files (`AND` ownership rules)
-  - Github CODEOWNERS supports only `OR` ownership rules, in contrast
-- Directory-level code ownership files to assign fine-grained code ownership
-- Supports optional reviewers (cc users/teams for non-blocking reviews)
-- Advanced global configuration (see [Advanced Configuration](#advanced-configuration))
+* Smart dismissal of stale reviews (only dismiss review when owned files change, rather than any reviewable push)
+* Supports multiple owners of files (`AND` ownership rules)
+  * Github CODEOWNERS supports only `OR` ownership rules, in contrast
+* Directory-level code ownership files to assign fine-grained code ownership
+* Supports optional reviewers (cc users/teams for non-blocking reviews)
+* Advanced global configuration (see [Advanced Configuration](#advanced-configuration))
 
 ### Caveats & Disclaimer
 
@@ -157,12 +158,12 @@ However, the parser will replace trailing `/` with trailing `/**` to indirectly
 
 This is the priority of file owners in order from highest priority to lowest priority:
 
-- specific file owner
-- wildcard file owner
-- globstar file owner
-- globstar file owner from parent dirs (recursive)
-- fallback owner for dir
-- fallback owner from parent dir (recursive)
+* specific file owner
+* wildcard file owner
+* globstar file owner
+* globstar file owner from parent dirs (recursive)
+* fallback owner for dir
+* fallback owner from parent dir (recursive)
 
 This means if there is overlap in rules, the last declared will be the owner.  This is similar to GitHub `CODEOWNERS`, except with type-of-rule priority.
 
@@ -249,16 +250,16 @@ A CLI tool is available which provides some utilities for working with `.codeown
 
 You can download the built tools via [releases](https://github.com/multimediallc/codeowners-plus/releases) or build from source:
 ```
-go build -o codeowners-cli ./cmd/cli/main.go
+go build -o codeowners-cli ./tools/cli/main.go
 ```
 
 Available commands are:
 
-- `unowned` to check for unowned files
-- `owner` to check who owns a specific file
-- `verify` to check for typos in a `.codeowners` file
+* `unowned` to check for unowned files
+* `owner` to check who owns a specific file
+* `verify` to check for typos in a `.codeowners` file
 
 ## Future Features
 
-- Inline ownership comments for having owners for specific functions, classes, etc.
+* Inline ownership comments for having owners for specific functions, classes, etc.
 

SECURITY.md

@@ -0,0 +1,5 @@
+# Reporting Security Issues
+
+If you believe you have found a security vulnerability in Codeowners Plus, we encourage you to let us know right away at <[email protected]>.
+
+We will investigate all legitimate reports and do our best to quickly fix the problem.

go.mod

@@ -17,5 +17,5 @@ require (
 	github.com/google/go-querystring v1.1.0 // indirect
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
 	github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1 // indirect
-	golang.org/x/sync v0.7.0 // indirect
+	golang.org/x/sync v0.10.0 // indirect
 )

go.sum

@@ -31,8 +31,8 @@ github.com/urfave/cli/v2 v2.27.5 h1:WoHEJLdsXr6dDWoJgMq/CboDmyY/8HMMH1fTECbih+w=
 github.com/urfave/cli/v2 v2.27.5/go.mod h1:3Sevf16NykTbInEnD0yKkjDAeZDS0A6bzhBH5hrMvTQ=
 github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1 h1:gEOO8jv9F4OT7lGCjxCBTO/36wtF6j2nSip77qHd4x4=
 github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1/go.mod h1:Ohn+xnUBiLI6FVj/9LpzZWtj1/D6lUovWYBkxHVV3aM=
-golang.org/x/sync v0.7.0 h1:YsImfSBoP9QPYL0xyKJPq0gcaJdG3rInoqxTWbfQu9M=
-golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
+golang.org/x/sync v0.10.0 h1:3NQrjDixjgGwUOCaF8w2+VYHv0Ve/vGYSbdkTa98gmQ=
+golang.org/x/sync v0.10.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

goreleaser.yml

@@ -13,7 +13,7 @@ before:
 builds:
   # You can have multiple builds defined as a yaml list
   - id: "cli"
-    main: ./cmd/cli
+    main: ./tools/cli
     binary: codeowners-cli
     env:
       - CGO_ENABLED=0