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

WIP :: TODO: Splunk Team who are the CodeOwners? :: Fix Issue #237 CODEOWNERS #238

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# TODO: Splunk Team who are the CodeOwners?

# https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-code-owners
# This is a comment.
# Each line is a file pattern followed by one or more owners.

# These owners will be the default owners for everything in
# the repo. Unless a later match takes precedence,
# @global-owner1 and @global-owner2 will be requested for
# review when someone opens a pull request.
# * @user-id @org-name/team-name

# Order is important; the last matching pattern takes the most
# precedence. When someone opens a pull request that only
# modifies JS files, only @js-owner and not the global
# owner(s) will be requested for a review.
# *.js @js-owner

# You can also use email addresses if you prefer. They'll be
# used to look up users just like we do for commit author
# emails.
# *.go [email protected]

# In this example, @doctocat owns any files in the build/logs
# directory at the root of the repository and any of its
# subdirectories.
# /build/logs/ @doctocat

# The `docs/*` pattern will match files like
# `docs/getting-started.md` but not further nested files like
# `docs/build-app/troubleshooting.md`.
# docs/* [email protected]

# In this example, @octocat owns any file in an apps directory
# anywhere in your repository.
# apps/ @octocat

# In this example, @doctocat owns any file in the `/docs`
# directory in the root of your repository and any of its
# subdirectories.
# /docs/ @doctocat

# Until restrictions are added in this app, one way to preserve admin/push permissions is to utilize the GitHub CodeOwners
# feature to set one or more administrative users as the code owner of the `.github/settings.yml` file, and turn on
# "require code owner review" for the master branch. This does have the side effect of requiring code owner review for the
# entire branch, but helps preserve permission levels.
# .github/settings.yml @user-id @org-name/team-name
9 changes: 6 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,12 @@ We love to see pull requests!
To create a pull request:

1. Fill out the [Individual Contributor Agreement][indivcontrib].
1. Fork [the repository][repo].
1. Make changes to the **`main`** branch, preferably with tests.
1. Create a [pull request][pulls] against the **`main`** branch.
2. Fork [the repository][repo].
3. Make changes to the **`main`** branch, preferably with tests.
4. Create a [pull request][pulls] against the **`main`** branch.

### Code Reviews
Contributions need to be reviewed by the [CODEOWNERS](.github/CODEOWNERS)

## Contact us

Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,9 @@ command:

git clone https://github.com/splunk/splunk-library-javalogging.git

### Code Reviews
Contributions need to be reviewed by the [CODEOWNERS](.github/CODEOWNERS)

## Support

The Splunk logging for Java is community-supported.
Expand Down