docs: add issue and PR templates
This commit is contained in:
parent
159ad2f109
commit
76b8779faf
|
@ -0,0 +1,37 @@
|
||||||
|
---
|
||||||
|
name: Bug report
|
||||||
|
about: Create a report to help us improve
|
||||||
|
title: ''
|
||||||
|
labels: ''
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Summary:
|
||||||
|
[Provide a brief summary of the issue.]
|
||||||
|
|
||||||
|
### Environment:
|
||||||
|
- Operating System:
|
||||||
|
- Browser (If applicable):
|
||||||
|
- Project Version:
|
||||||
|
- Additional relevant information:
|
||||||
|
|
||||||
|
### Steps to Reproduce:
|
||||||
|
1. [First step]
|
||||||
|
2. [Second step]
|
||||||
|
3. [And so on…]
|
||||||
|
|
||||||
|
### Expected Behavior:
|
||||||
|
[Provide a detailed description of the expected behavior.]
|
||||||
|
|
||||||
|
### Actual Behavior:
|
||||||
|
[Provide a detailed description of the actual behavior you are experiencing.]
|
||||||
|
|
||||||
|
### Screenshots (if applicable):
|
||||||
|
[Attach screenshots to help illustrate the issue.]
|
||||||
|
|
||||||
|
### Additional Information:
|
||||||
|
[Any additional information, configuration, or data that might be necessary to reproduce the issue.]
|
||||||
|
|
||||||
|
### Potential Solutions (if applicable):
|
||||||
|
[Optional: Provide any thoughts or ideas you might have on potential solutions to the issue.]
|
|
@ -0,0 +1,17 @@
|
||||||
|
---
|
||||||
|
name: Feature request
|
||||||
|
about: Suggest an idea for this project
|
||||||
|
title: ''
|
||||||
|
labels: ''
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Feature Request:
|
||||||
|
[Quick summary of the feature you would like to be added.]
|
||||||
|
|
||||||
|
### Why is this feature important?
|
||||||
|
[Explain why you think this feature would be beneficial.]
|
||||||
|
|
||||||
|
### How should it work?
|
||||||
|
[Briefly describe how you envision this feature working, or how you would like it to be implemented.]
|
|
@ -1,129 +0,0 @@
|
||||||
# Official labels
|
|
||||||
- name: bug
|
|
||||||
description: Something isn't working
|
|
||||||
color: d73a4a
|
|
||||||
- name: documentation
|
|
||||||
description: Improvements or additions to documentation
|
|
||||||
color: 0075ca
|
|
||||||
- name: duplicate
|
|
||||||
description: This issue or pull request already exists
|
|
||||||
color: cfd3d7
|
|
||||||
- name: enhancement
|
|
||||||
description: New feature or request
|
|
||||||
color: a2eeef
|
|
||||||
- name: good first issue
|
|
||||||
description: Good for newcomers
|
|
||||||
color: 7057ff
|
|
||||||
- name: help wanted
|
|
||||||
description: Extra attention is needed
|
|
||||||
color: 008672
|
|
||||||
- name: invalid
|
|
||||||
description: This doesn't seem right
|
|
||||||
color: e4e669
|
|
||||||
- name: question
|
|
||||||
description: Further information is requested
|
|
||||||
color: d876e3
|
|
||||||
- name: wontfix
|
|
||||||
description: This will not be worked on
|
|
||||||
color: ffffff
|
|
||||||
|
|
||||||
# Generally useful labels
|
|
||||||
- name: blocked
|
|
||||||
description: This issue is blocked by some other work
|
|
||||||
color: e0af74
|
|
||||||
- name: critical
|
|
||||||
description: This issue needs critical attention
|
|
||||||
color: B60205
|
|
||||||
- name: infra
|
|
||||||
description: Infra, devops, CI and related tasks
|
|
||||||
color: 277196
|
|
||||||
- name: milestone
|
|
||||||
description: Milestone issue with a subset of issues within a specific track
|
|
||||||
color: 1CC0B0
|
|
||||||
|
|
||||||
# Waku Product labels
|
|
||||||
- name: rqt:platforms
|
|
||||||
description: Requirement coming from a platform
|
|
||||||
color: A51BB5
|
|
||||||
|
|
||||||
# Tracks primarily within Secure Messaging or Waku Product project
|
|
||||||
- name: track:rln
|
|
||||||
description: RLN Track - (Secure Messaging/Applied ZK), relay and applications
|
|
||||||
color: C89BC6
|
|
||||||
- name: track:anonymity
|
|
||||||
description: Anonymity track (Secure Messaging)
|
|
||||||
color: 06B6C8
|
|
||||||
- name: track:operator-outreach
|
|
||||||
description: Operator outreach track (Secure Messaging/Waku Product)
|
|
||||||
color: B888AB
|
|
||||||
- name: track:ft-store
|
|
||||||
description: FT-Store track (Secure Messaging)
|
|
||||||
color: F5FD62
|
|
||||||
- name: track:discovery
|
|
||||||
description: Discovery track (Secure Messaging/Waku Product)
|
|
||||||
color: 6BEB61
|
|
||||||
- name: track:protocol-incentivization
|
|
||||||
description: Protocol Incentivization track (Secure Messaging), e.g. service credentials
|
|
||||||
color: 0037E3
|
|
||||||
- name: track:restricted-run
|
|
||||||
description: Restricted run track (Secure Messaging/Waku Product), e.g. filter, WebRTC
|
|
||||||
color: D91C35
|
|
||||||
- name: track:conversational-security
|
|
||||||
description: Conversational security track (Secure Messaging)
|
|
||||||
color: CC6B00
|
|
||||||
- name: track:nwaku-productionization
|
|
||||||
description: nwaku-productionization track (Waku Product)
|
|
||||||
color: 9DEA79
|
|
||||||
- name: track:nwaku-maintenance
|
|
||||||
description: nwaku-maintenance track (Waku Product)
|
|
||||||
color: 40F9F0
|
|
||||||
- name: track:network-testing
|
|
||||||
description: network-testing track (Secure Messaging/Waku Product)
|
|
||||||
color: bfd4f2
|
|
||||||
- name: track:platform-outreach
|
|
||||||
description: Platform outreach track (Waku Product)
|
|
||||||
color: 06B6C8
|
|
||||||
- name: track:sdks
|
|
||||||
description: SDKS track (Waku Product), including bindings
|
|
||||||
color: 34D557
|
|
||||||
- name: track:go-waku-productionization
|
|
||||||
description: go-waku-productionization track (Waku Product)
|
|
||||||
color: 9DEA79
|
|
||||||
|
|
||||||
# Tracks within zk-WASM project
|
|
||||||
- name: track:kickoff
|
|
||||||
description: Kickoff track (zk-WASM)
|
|
||||||
color: 06B6C8
|
|
||||||
|
|
||||||
# Tracks within RAD project
|
|
||||||
- name: track:waku-specs
|
|
||||||
description: Waku specs track (RAD)
|
|
||||||
color: 1d76db
|
|
||||||
- name: track:logos-specs
|
|
||||||
description: Logos specs track (RAD)
|
|
||||||
color: CA105D
|
|
||||||
- name: track:codex-specs
|
|
||||||
description: Codex specs track (RAD)
|
|
||||||
color: D9714D
|
|
||||||
- name: track:rfc-process
|
|
||||||
description: RFC process track (RAD)
|
|
||||||
color: BB9BAD
|
|
||||||
- name: track:status-specs
|
|
||||||
description: Status specs track (RAD)
|
|
||||||
color: 0052CC
|
|
||||||
- name: track:research-outreach
|
|
||||||
description: Research outreach track (RAD)
|
|
||||||
color: ACAD2D
|
|
||||||
|
|
||||||
# Tracks primarily within Applied ZK/Explorations project
|
|
||||||
- name: track:validator-privacy
|
|
||||||
description: Validator privacy track (Applied ZK/Explorations)
|
|
||||||
color: 53AE45
|
|
||||||
- name: track:zerokit
|
|
||||||
description: Zerokit track (Applied ZK/Explorations)
|
|
||||||
color: DF1D12
|
|
||||||
|
|
||||||
# Meta track for Vac org
|
|
||||||
- name: track:vac-org
|
|
||||||
description: Vac Org track (Meta)
|
|
||||||
color: 1A28E8
|
|
|
@ -0,0 +1,24 @@
|
||||||
|
### Description:
|
||||||
|
[Provide a brief description of the changes in the pull request.]
|
||||||
|
|
||||||
|
### Related Issue(s):
|
||||||
|
[Link to the related Issue(s), if any.]
|
||||||
|
|
||||||
|
### Changes Included:
|
||||||
|
- [ ] Bugfix (a change that fixes an issue)
|
||||||
|
- [ ] New feature (a change that adds new functionality)
|
||||||
|
- [ ] Refactoring (a change that improves code quality and/or architecture)
|
||||||
|
- [ ] Other (explain below)
|
||||||
|
|
||||||
|
### Implementation Details:
|
||||||
|
[Explain any new decisions made during the implementation of the changes.]
|
||||||
|
|
||||||
|
### Testing:
|
||||||
|
[Describe how the changes have been tested.]
|
||||||
|
|
||||||
|
### Checklist:
|
||||||
|
- [ ] My code follows the style guidelines of this project
|
||||||
|
- [ ] I have performed a self-review of my own code
|
||||||
|
- [ ] I have commented my code, particularly in hard-to-understand areas
|
||||||
|
- [ ] My changes generate no new warnings
|
||||||
|
- [ ] Any dependent changes have been merged and published in downstream modules
|
|
@ -1,22 +0,0 @@
|
||||||
name: Add new issues and PRs to Vac Research project board
|
|
||||||
|
|
||||||
on:
|
|
||||||
issues:
|
|
||||||
types: [opened]
|
|
||||||
pull_request:
|
|
||||||
types: [opened]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
add-to-project:
|
|
||||||
name: Add issue to project
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/add-to-project@v0.3.0
|
|
||||||
with:
|
|
||||||
# You can target a repository in a different organization
|
|
||||||
# to the issue
|
|
||||||
project-url: https://github.com/orgs/vacp2p/projects/6
|
|
||||||
github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}
|
|
||||||
# NOTE Currently all issues are added, might want to limit this
|
|
||||||
#labeled: bug, needs-triage
|
|
||||||
#label-operator: OR
|
|
|
@ -1,17 +0,0 @@
|
||||||
name: Sync labels
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
paths:
|
|
||||||
- .github/labels.yml
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v2
|
|
||||||
- uses: micnncim/action-label-syncer@v1
|
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
with:
|
|
||||||
manifest: .github/labels.yml
|
|
Loading…
Reference in New Issue