Skip to content

Commit

Permalink
Add CODEOWNERS and PR template
Browse files Browse the repository at this point in the history
  • Loading branch information
m1k3lm committed Dec 27, 2023
1 parent e106eaa commit f4f724c
Show file tree
Hide file tree
Showing 2 changed files with 116 additions and 0 deletions.
59 changes: 59 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# This is a comment.
# Each line is a file pattern followed by one or more owners or a team.

# 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.
# ex1: * @john.doe
# ex2: * @sequra/dev
* @ristokekovic
* @luka-stanimirovic-logeecom
* @petar-rankovic-logeecom
* @sequra/integrations

# 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.
# *.rb docs@example.com

# Teams can be specified as code owners as well. Teams should
# be identified in the format @org/team-name. Teams must have
# explicit write access to the repository. In this example,
# the Paltform team in the sequra organization owns all .txt files.
# *.txt @sequra/platform

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

# The `docs/*` pattern will match files like
# `docs/getting-started.md` but not further nested files like
# `docs/build-app/troubleshooting.md`.
# docs/* docs@example.com

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

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

# In this example, any change inside the `/scripts` directory
# will require approval from @john.doe or @james.dean.
# /scripts/ @john.doe @james.dean

# In this example, @john.doe owns any file in the `/apps`
# directory in the root of your repository except for the `/apps/github`
# subdirectory, as its owners are left empty.
# /apps/ @john.doe
# /apps/github
57 changes: 57 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂
✂✂✂ REMOVE FROM THIS PART BEFORE SUBMITTING YOUR PULL REQUEST ✂✂✂
✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂

Here are some friendly reminders before submitting your pull request:

- There should be an issue describing the motivation for this change.
- Everything should be well tested.
- Check that you are not making any intensive/slow queries (provide db explain if necessary).
- Migrations should be safe https://sequra.atlassian.net/wiki/display/EN/Safe+Operations+For+High+Volume+PostgreSQL

YOU CAN REMOVE THE PARTS OF THE TEMPLATE THAT DO NOT APPLY TO YOUR PULL REQUEST

✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂
✂✂✂ REMOVE UP TO THIS PART BEFORE SUBMITTING YOUR PULL REQUEST ✂✂✂
✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂✂

### What is the goal?

_Provide a description of the overall goal (you can usually use the one from the issue)_

### References
* **Issue:** _jira issue goes here, if suggesting a new feature or change, please discuss it in an issue first_
* **Related pull-requests:** _list of related pull-requests (comma-separated): #1, #2_
* **Sentry errors:** _list of links to Sentry errors (comma-separated): link1, link2_
* **Any other references (AppSignal, Prometheus, ...):** _list of links to other references (comma-separated): link1, link2_

### How is it being implemented?

_Provide a description of the implementation_

### Opportunistic refactorings

_Have you improved the code/app in anyway? Explain what you did._

### Caveats

_If you find any, please describe all the special conditions._

### Does it affect (changes or update) any sensitive data?

_Check [Sensitive data list documentation](../blob/master/docs/sensitive_data/README.md) and [Sensitive data list](../blob/master/docs/sensitive_data/sensitive-data.yml)

### How is it tested?

_Automatic tests? Manual tests?_

_If it cannot be tested explain why._

_Add use cases if specs are incomplete or missing._

### How is it going to be deployed?

_If it does not require anything special, just write "Standard deployment". Otherwise, put the required steps._

- [ ] _Step 1_
- [ ] _Step 2_

0 comments on commit f4f724c

Please sign in to comment.