Skip to content
This repository was archived by the owner on May 14, 2025. It is now read-only.

Commit c329486

Browse files
LesnyRumcajsLesnyRumcajs
authored
chore: add GH template boilerplate (#43)
1 parent 1aeae2c commit c329486

File tree

20 files changed

+684
-8
lines changed

20 files changed

+684
-8
lines changed

‎.github/CODEOWNERS‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Two members of the Forest team are automatically (and randomly) assigned to review all PRs.
2+
* @ChainSafe/Forest

‎.github/ISSUE_TEMPLATE/1-bug_report.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
name: Bug report
3+
about: Provide a report of unexpected behaviour
4+
title: ""
5+
labels: "Type: Bug"
6+
assignees: ""
7+
---
8+
9+
## Describe the bug
10+
11+
<!-- A clear and concise description of what the bug is. -->
12+
13+
## To reproduce
14+
15+
<!-- Steps to reproduce the behaviour: -->
16+
17+
1. Go to '...'
18+
2. Run '....'
19+
3. See error
20+
21+
## Log output
22+
23+
<!-- Please paste the log output derived from the error. -->
24+
<details>
25+
<summary>Log Output</summary>
26+
27+
```Paste log output here
28+
paste log output...
29+
```
30+
</details>
31+
32+
## Expected behaviour
33+
34+
<!-- A clear and concise description of what you expected to happen. -->
35+
36+
## Screenshots
37+
38+
<!-- If applicable, add screenshots to help explain your problem. -->
39+
40+
## Environment (please complete the following information):
41+
42+
- OS:
43+
- Branch/commit
44+
- Hardware
45+
46+
## Other information and links
47+
48+
<!-- Add any other context about the problem here. -->
49+
50+
<!-- Thank you 🙏 -->

‎.github/ISSUE_TEMPLATE/2-user_request.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: User Request
3+
about: Request a feature or change
4+
title: ""
5+
labels: "Type: Request"
6+
assignees: ""
7+
---
8+
9+
# Summary
10+
11+
<!-- Provide a high-level summary of the issue -->
12+
13+
# Requirements
14+
15+
<!-- Provide a list of requirements that you believe would satisfy the completion of this request -->
16+
17+
# Motivation
18+
19+
<!-- Give us some insight why this is important for you -->

‎.github/ISSUE_TEMPLATE/3-epic.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Epic
3+
about: "[Internal] Larger chunk of work that can be broken down into smaller tasks"
4+
title: ""
5+
labels: "Type: Epic"
6+
assignees: ""
7+
---
8+
9+
# Summary
10+
11+
<!-- Provide a summary of the epic -->
12+
13+
# Motivation
14+
15+
<!-- Describe the rationale for this epic. What does it enable? Who does it serve? -->
16+
17+
# Tasks
18+
19+
<!-- Provide a list of individual tasks that would complete this epic -->
20+
<!-- This should be a list of issues once they are created -->
21+
22+
- [ ]
23+
24+
# Risks & Dependencies
25+
26+
<!-- Identify any potential risks or external dependencies in completing this epic -->
27+
28+
# Additional Links & Resources
29+
30+
<!-- Any additional context or resources that may be relevant -->

‎.github/ISSUE_TEMPLATE/4-task.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Task
3+
about: "[Internal] A specific, actionable unit of work"
4+
title: ""
5+
labels: "Type: Task"
6+
assignees: ""
7+
---
8+
9+
# Summary
10+
11+
<!-- Describe the task -->
12+
13+
# Completion Criteria
14+
15+
<!-- List the necessary criteria to complete this issue -->
16+
17+
- [ ]
18+
19+
# Additional Links & Resources
20+
21+
<!-- Anything that might need to be referenced during implementation -->

‎.github/ISSUE_TEMPLATE/5-other.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Other
3+
about: Use wisely 🧐
4+
title: ""
5+
labels: ""
6+
assignees: ""
7+
---
8+
9+
<!-- Please complete this checklist before proceeding -->
10+
11+
This issue is NOT:
12+
13+
- [ ] A bug
14+
- [ ] A user-request
15+
- [ ] An epic
16+
- [ ] A task
17+
18+
Please check the other issue types if any of these categories apply.
19+
20+
---
21+
22+
<!-- Type below this line -->

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: "Filecoin Slack (#fil-forest-help or #fil-forest-dev)"
4+
url: https://join.slack.com/t/filecoinproject/shared_invite/enQtNTUwNTI1Mzk5MDYwLTY4YmFjMzRlZjFiNDc0NmI2N2JjMjk5YTAyMDUyODljODg3MGI0ZGRhZTI5ZDNkZTAyNjkyMzI1ODM1YjA1MWI
5+
about: Please ask questions here.
6+
- name: General Filecoin Discussion Forum
7+
url: https://github.com/filecoin-project/community/discussions
8+
about: Please ask any general Filecoin questions here.
9+
- name: Forest Discussion Forum
10+
url: https://github.com/ChainSafe/forest/discussions
11+
about: Please ask Forest specific questions here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
## Summary of changes
2+
3+
<!-- Please write a comprehensive summary of your changes and what was the motivation behind them -->
4+
5+
Changes introduced in this pull request:
6+
7+
-
8+
9+
## Reference issue to close (if applicable)
10+
11+
<!-- Include the issue reference this pull request is connected to -->
12+
<!-- See more keywords here https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword -->
13+
<!--(e.g. Closes #1)-->
14+
15+
Closes
16+
17+
## Other information and links
18+
19+
<!-- Add any other context about the pull request here. Those might be helpful links based on your investigation, relevant commits from this or other repositories or anything else -->
20+
21+
## Change checklist
22+
23+
<!-- Please add a changelog entry for your change if needed. -->
24+
<!-- Follow this format https://keepachangelog.com/en/1.0.0/ -->
25+
26+
- [ ] I have performed a self-review of my own code,
27+
- [ ] I have made corresponding changes to the documentation. All new code adheres to the team's [documentation standards](https://github.com/ChainSafe/forest/wiki/Documentation-practices),
28+
- [ ] I have added tests that prove my fix is effective or that my feature works (if possible),
29+
30+
<!-- Thank you 🔥 -->

‎.github/dependabot.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Please see the documentation for all configuration options:
2+
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
3+
4+
version: 2
5+
updates:
6+
- package-ecosystem: "cargo"
7+
directory: "/" # Location of package manifests
8+
open-pull-requests-limit: 1
9+
schedule:
10+
interval: "weekly"
11+
# https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot#enabling-dependabot-version-updates-for-actions
12+
- package-ecosystem: "github-actions"
13+
directory: "/"
14+
open-pull-requests-limit: 1
15+
schedule:
16+
interval: "weekly"

‎.github/workflows/docs.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Docs
2+
3+
# Cancel workflow if there is a new change to the branch.
4+
concurrency:
5+
group: ${{ github.workflow }}-${{ github.ref }}
6+
cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
7+
8+
on:
9+
push:
10+
branches:
11+
- main
12+
paths:
13+
- '**.md'
14+
- '.github/workflows/docs.yml'
15+
merge_group:
16+
pull_request:
17+
branches:
18+
- main
19+
paths:
20+
- '**.md'
21+
- '.github/workflows/docs.yml'
22+
23+
jobs:
24+
check-docs:
25+
name: Markdown Lint
26+
runs-on: ubuntu-24.04
27+
steps:
28+
- uses: actions/checkout@v4
29+
- name: Lint Markdown
30+
run: make md-check
31+
- name: Link check
32+
uses: lycheeverse/[email protected]
33+
with:
34+
args: '*.md .github/*.md .github/**/*.md .config/*.md'
35+
# Fail action on broken links
36+
fail: true

0 commit comments

Comments
 (0)