-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add GH template boilerplate (#43)
- Loading branch information
1 parent
1aeae2c
commit c329486
Showing
20 changed files
with
684 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Two members of the Forest team are automatically (and randomly) assigned to review all PRs. | ||
* @ChainSafe/Forest |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
--- | ||
name: Bug report | ||
about: Provide a report of unexpected behaviour | ||
title: "" | ||
labels: "Type: Bug" | ||
assignees: "" | ||
--- | ||
|
||
## Describe the bug | ||
|
||
<!-- A clear and concise description of what the bug is. --> | ||
|
||
## To reproduce | ||
|
||
<!-- Steps to reproduce the behaviour: --> | ||
|
||
1. Go to '...' | ||
2. Run '....' | ||
3. See error | ||
|
||
## Log output | ||
|
||
<!-- Please paste the log output derived from the error. --> | ||
<details> | ||
<summary>Log Output</summary> | ||
|
||
```Paste log output here | ||
paste log output... | ||
``` | ||
</details> | ||
|
||
## Expected behaviour | ||
|
||
<!-- A clear and concise description of what you expected to happen. --> | ||
|
||
## Screenshots | ||
|
||
<!-- If applicable, add screenshots to help explain your problem. --> | ||
|
||
## Environment (please complete the following information): | ||
|
||
- OS: | ||
- Branch/commit | ||
- Hardware | ||
|
||
## Other information and links | ||
|
||
<!-- Add any other context about the problem here. --> | ||
|
||
<!-- Thank you 🙏 --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
name: User Request | ||
about: Request a feature or change | ||
title: "" | ||
labels: "Type: Request" | ||
assignees: "" | ||
--- | ||
|
||
# Summary | ||
|
||
<!-- Provide a high-level summary of the issue --> | ||
|
||
# Requirements | ||
|
||
<!-- Provide a list of requirements that you believe would satisfy the completion of this request --> | ||
|
||
# Motivation | ||
|
||
<!-- Give us some insight why this is important for you --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
name: Epic | ||
about: "[Internal] Larger chunk of work that can be broken down into smaller tasks" | ||
title: "" | ||
labels: "Type: Epic" | ||
assignees: "" | ||
--- | ||
|
||
# Summary | ||
|
||
<!-- Provide a summary of the epic --> | ||
|
||
# Motivation | ||
|
||
<!-- Describe the rationale for this epic. What does it enable? Who does it serve? --> | ||
|
||
# Tasks | ||
|
||
<!-- Provide a list of individual tasks that would complete this epic --> | ||
<!-- This should be a list of issues once they are created --> | ||
|
||
- [ ] | ||
|
||
# Risks & Dependencies | ||
|
||
<!-- Identify any potential risks or external dependencies in completing this epic --> | ||
|
||
# Additional Links & Resources | ||
|
||
<!-- Any additional context or resources that may be relevant --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
name: Task | ||
about: "[Internal] A specific, actionable unit of work" | ||
title: "" | ||
labels: "Type: Task" | ||
assignees: "" | ||
--- | ||
|
||
# Summary | ||
|
||
<!-- Describe the task --> | ||
|
||
# Completion Criteria | ||
|
||
<!-- List the necessary criteria to complete this issue --> | ||
|
||
- [ ] | ||
|
||
# Additional Links & Resources | ||
|
||
<!-- Anything that might need to be referenced during implementation --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
name: Other | ||
about: Use wisely 🧐 | ||
title: "" | ||
labels: "" | ||
assignees: "" | ||
--- | ||
|
||
<!-- Please complete this checklist before proceeding --> | ||
|
||
This issue is NOT: | ||
|
||
- [ ] A bug | ||
- [ ] A user-request | ||
- [ ] An epic | ||
- [ ] A task | ||
|
||
Please check the other issue types if any of these categories apply. | ||
|
||
--- | ||
|
||
<!-- Type below this line --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
blank_issues_enabled: true | ||
contact_links: | ||
- name: "Filecoin Slack (#fil-forest-help or #fil-forest-dev)" | ||
url: https://join.slack.com/t/filecoinproject/shared_invite/enQtNTUwNTI1Mzk5MDYwLTY4YmFjMzRlZjFiNDc0NmI2N2JjMjk5YTAyMDUyODljODg3MGI0ZGRhZTI5ZDNkZTAyNjkyMzI1ODM1YjA1MWI | ||
about: Please ask questions here. | ||
- name: General Filecoin Discussion Forum | ||
url: https://github.com/filecoin-project/community/discussions | ||
about: Please ask any general Filecoin questions here. | ||
- name: Forest Discussion Forum | ||
url: https://github.com/ChainSafe/forest/discussions | ||
about: Please ask Forest specific questions here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
## Summary of changes | ||
|
||
<!-- Please write a comprehensive summary of your changes and what was the motivation behind them --> | ||
|
||
Changes introduced in this pull request: | ||
|
||
- | ||
|
||
## Reference issue to close (if applicable) | ||
|
||
<!-- Include the issue reference this pull request is connected to --> | ||
<!-- 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 --> | ||
<!--(e.g. Closes #1)--> | ||
|
||
Closes | ||
|
||
## Other information and links | ||
|
||
<!-- 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 --> | ||
|
||
## Change checklist | ||
|
||
<!-- Please add a changelog entry for your change if needed. --> | ||
<!-- Follow this format https://keepachangelog.com/en/1.0.0/ --> | ||
|
||
- [ ] I have performed a self-review of my own code, | ||
- [ ] 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), | ||
- [ ] I have added tests that prove my fix is effective or that my feature works (if possible), | ||
|
||
<!-- Thank you 🔥 --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Please see the documentation for all configuration options: | ||
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates | ||
|
||
version: 2 | ||
updates: | ||
- package-ecosystem: "cargo" | ||
directory: "/" # Location of package manifests | ||
open-pull-requests-limit: 1 | ||
schedule: | ||
interval: "weekly" | ||
# 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 | ||
- package-ecosystem: "github-actions" | ||
directory: "/" | ||
open-pull-requests-limit: 1 | ||
schedule: | ||
interval: "weekly" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
name: Docs | ||
|
||
# Cancel workflow if there is a new change to the branch. | ||
concurrency: | ||
group: ${{ github.workflow }}-${{ github.ref }} | ||
cancel-in-progress: ${{ github.ref != 'refs/heads/main' }} | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
paths: | ||
- '**.md' | ||
- '.github/workflows/docs.yml' | ||
merge_group: | ||
pull_request: | ||
branches: | ||
- main | ||
paths: | ||
- '**.md' | ||
- '.github/workflows/docs.yml' | ||
|
||
jobs: | ||
check-docs: | ||
name: Markdown Lint | ||
runs-on: ubuntu-24.04 | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Lint Markdown | ||
run: make md-check | ||
- name: Link check | ||
uses: lycheeverse/[email protected] | ||
with: | ||
args: '*.md .github/*.md .github/**/*.md .config/*.md' | ||
# Fail action on broken links | ||
fail: true |
Oops, something went wrong.