Skip to content

Commit

Permalink
Configure GitHub (#11)
Browse files Browse the repository at this point in the history
Configures the GitHub templates, workflows and bots.

Signed-off-by: Rémy Greinhofer <[email protected]>
rgreinho authored Mar 29, 2024
1 parent d724f6e commit b61d49c
Showing 10 changed files with 380 additions and 0 deletions.
16 changes: 16 additions & 0 deletions .github/.kodiak.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
version = 1

[merge]
blacklist_title_regex = "^WIP:.*"
blacklist_labels = ["do-not-merge"]
delete_branch_on_merge = true
method = "squash"
prioritize_ready_to_merge = true
require_automerge_label = false

[update]
always = true
require_automerge_label = false

[approve]
auto_approve_usernames = ["dependabot"]
9 changes: 9 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Contributing

## General guidelines

This project follows the [BNA Mechanics Contributing Guidelines]. Refer to them
for general principles.

[bna mechanics contributing guidelines]:
https://peopleforbikes.github.io/contributing/
84 changes: 84 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
name: Bug report
about: Create a report to help us improve
labels: "kind/bug"
---

# Bug report

<!-- Provide a general summary of the issue in the title above. -->

## Current Behavior

<!-- Tell us what is currently happening. -->

## Expected Behavior

<!--
Tell us how it should work, how it differs from the current implementation.
-->

## Possible Solution

<!--
Suggest a fix/reason for the bug, or ideas how to implement it.
Delete if not applicable/relevant.
-->

## Steps to Reproduce

<!--
Provide a link to a live example, or an unambiguous set of steps to
reproduce this bug. Include code to reproduce, if relevant.
-->

1.
2.
3.

## Context

<!--
How has this issue affected you? What are you trying to accomplish?
Providing context helps us come up with a solution that is most useful
in the real world.
-->

## Your Environment

<!--
Instructions:
* Run the following script in a terminal (OSX only)
* Paste the output in the code section at the bottom of this report
(the output is automatically copied to your clipboard buffer)
* Adjust the values if needed
* If you cannot run the script for any reason, simply replace the
values in the example
COMMIT=$(git log -1 --pretty=format:"%h %s %d")
FIREFOX=$(/Applications/Firefox.app/Contents/MacOS/firefox --version 2>/dev/null||true)
CHROME=$(/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome \
--version 2>/dev/null||true)
SYSTEM=$(system_profiler SPSoftwareDataType|grep macOS | xargs)
OUTPUT="$(cat <<EOF
Last commit:
${COMMIT}
Browser(s):
${FIREFOX}
${CHROME}
${SYSTEM}
EOF
)"
echo "$OUTPUT" | tee >(pbcopy)
-->

```bash
(replace the example bellow with the script output)
Last commit:
583bc87 Fix configuration issue
Browser(s):
Mozilla Firefox 60.0
Google Chrome 66.0.3359.139
System Version: macOS 10.13.4 (17E202)
```
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Feature request
about: Suggest an idea for this project
labels: "kind/feature"
---

# Feature request

<!-- Provide a general summary of the issue in the title above. -->

## Current Behavior

<!-- Tell us what is currently happening. -->

## Expected Behavior

<!-- Tell us how it should work, how it differs from current implementation. -->

## Possible Solution

<!--
Suggest ideas how to implement the addition or change.
Delete if not applicable/relevant.
-->
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/help_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Help request
about: Ask for help
labels: feedback/question
---

# Help request

<!-- Provide a general summary of the issue in the title above. -->

## Problem

<!-- Describe your problem or state your question. -->

<!-- What have you attempted to do to workaround the problem? -->

<!-- What type of help do you need from us? -->
54 changes: 54 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Pull Request

## Types of changes

<!--
What types of changes does your code introduce?
Select all the choices that apply:
-->

- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing functionality to
change)
- Code cleanup / Refactoring
- Documentation
- Infrastructure and automation

## Description

<!--
Describe your changes in detail.
Add a screenshot if applicable.
-->

<!--
Motivation and Context
Why is this change required? What problem does it solve?
-->

<!--
How Has This Been Tested?
Add any information that could help the reviewer to validate the PR.
Please describe in detail how you tested your changes, include details
of your testing environment, and the tests you ran to see how your
change affects other areas of the code, etc.
-->

## Checklist

<!--
Go over all the following points, and put an `x` in all the boxes that
apply. If you're unsure about any of these, don't hesitate to ask.
We're here to help!
-->

- [] I have updated the documentation accordingly
- [] I have updated the Changelog (if applicable)

<!--
Place the URL of the issue here if this PR fixes an existing issue.
Use either the `username/repository#` syntax (preferred) or the *FULL* URL.
-->

Fixes: PeopleForBikes/bna-dashboard#
13 changes: 13 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
version: 2
updates:
# Maintain dependencies for GitHub Actions.
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"

# Maintain NPM dependencies.
- package-ecosystem: npm
directory: "/"
schedule:
interval: weekly
108 changes: 108 additions & 0 deletions .github/labels.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
---
labels:
# Kinds.
- name: "kind/bug"
color: "#D73A4A"
description: "Something isn't working"
- name: "kind/design"
color: "#8000FF"
description: "Visual aspect"
- name: "kind/docs"
color: "#000BE0"
description: "Document the project"
- name: "kind/enhancement"
color: "#A2EEEF"
description: "Improve an existing feature"
- name: "kind/optimization"
color: "#A2EEEF"
description: "Optimize an existing feature"
- name: "kind/feature"
color: "#A2EEEF"
description: "New feature request"
- name: "kind/infrastructure"
color: "#387499"
description: "Issue regarding the local or cloud infrastructure setup"
- name: "kind/automation"
color: "#387499"
description: "Automate your tasks"
- name: "kind/security"
color: "#993333"
description: "CVEs and other security flaws"

# Feedback.
- name: "feedback/question"
color: "#D876E3"
description: "Further information is requested"
- name: "feedback/discussion"
color: "#D876E3"
description: "Discuss a specific aspect of the project"

# T-Shirt sizes.
- name: "size/XS"
color: "#00FF00"
description: "Extra small (0-9 lines of changes)"
- name: "size/S"
color: "#CCFF66"
description: "Small (10-29 lines of changes)"
- name: "size/M"
color: "#FFFF00"
description: "Medium (30-99 lines of changes)"
- name: "size/L"
color: "#FF9933"
description: "Large (100-499 lines of changes)"
- name: "size/XL"
color: "#B60205"
description: "Extra large (500-999 lines of changes)"
- name: "size/XXL"
color: "#8B0000"
description: "Extra Extra Large (1000+ lines of changes)"

# Experience.
- name: "exp/beginner"
color: "#CBE4CE"
description: "Good for newcomers"
- name: "exp/intermediate"
color: "#CBE4CE"
description: "Show off your skills"
- name: "exp/expert"
color: "#CBE4CE"
description: "I have nothing else to teach you"

# Statuses.
- name: "status/claimed"
color: "#FBCA04"
description: "Assigned"
- name: "status/help wanted"
color: "#008672"
description: "Could use an extra brain"
- name: "status/more info needed"
color: "#008672"
description: "Needs clarification"
- name: "status/invalid"
color: "#D2DAE1"
description: "No further triaging"
- name: "status/wontfix"
color: "#D2DAE1"
description: "Fix is too controversial or do not want to implement it"
- name: "status/duplicate"
color: "#D2DAE1"
description: "This issue or pull request already exists"
- name: "status/review-carefully!"
color: "#B60205"
description: "Requires extra attention during review"

# Environment.
- name: "environment/dev"
color: "#F7FBFF"
description: "Developer environment"
- name: "environment/prod"
color: "#F7FBFF"
description: "Production environment"

# Bots.
- name: "dependencies"
color: "#0366d6"
description: "Pull requests that update a dependency file"
- name: "do-not-merge"
color: "#DC143C"
description: "Prevents PRs with this label to be merged"
31 changes: 31 additions & 0 deletions .github/stale.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Number of days of inactivity before a PR becomes stale.
daysUntilStale: 21
# Number of days of inactivity before a stale PR is closed.
daysUntilClose: 7

# Limit to only `pulls`.
only: pulls

# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable.
exemptLabels:
- no-mergify
- do-not-merge

# Comment to post when marking an issue as stale. Set to `false` to disable.
markComment: >
This pull request has been automatically marked as stale because it has not had
recent activity.
It will be closed in 7 days if no further activity occurs.
Thank you for your contribution!
# Comment to post when closing a stale issue. Set to `false` to disable.
closeComment: >
This pull request has been automatically closed because there has
been no activity for 28 days.
Please feel free to reopen it (or open a new one) if the proposed
change is still appropriate.
Thank you for your contribution!
24 changes: 24 additions & 0 deletions .github/workflows/ci-npm.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: ci-npm

on:
pull_request:
types:
- opened
- synchronize
- reopened

jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

0 comments on commit b61d49c

Please sign in to comment.