Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contrib revamp #1456

Merged
merged 31 commits into from
Jul 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
a96f322
revamp contrib and add more details
ifrit98 Jul 20, 2023
59a046f
mention miners/validators and address feedback
ifrit98 Jul 21, 2023
867f0ca
add black formatting to staging
ifrit98 Jul 21, 2023
cb90ca2
update links for templates
ifrit98 Jul 24, 2023
5e07a84
reword PR template section making CI checks passing REQUIRED
ifrit98 Jul 24, 2023
54d973d
use commit hash instead of version for representative tagging
ifrit98 Jul 24, 2023
d646939
add link to commit rule examples section
ifrit98 Jul 24, 2023
ebeec8e
add interactive rebase and fixup mentions/examples
ifrit98 Jul 24, 2023
06bbfc9
add tooling mentions, move rebase -i/--fixup to bottom
ifrit98 Jul 24, 2023
4ccc397
remove line referencing github actions
ifrit98 Jul 24, 2023
d5c6084
update github PULL_REQUEST_TEMPLATEs and ISSUE_TEMPLATEs
ifrit98 Jul 24, 2023
5ba662f
add short description of miners and validtors
ifrit98 Jul 24, 2023
e880d54
remove markdown conflicting templates
ifrit98 Jul 24, 2023
b6c7db7
add black format check to circleCI
ifrit98 Jul 24, 2023
7184193
add namespace call
ifrit98 Jul 24, 2023
71b05e9
add format check to circleCI
ifrit98 Jul 24, 2023
8980d44
py 38
ifrit98 Jul 24, 2023
647d4fe
add closest python 38 version to bittensor req
ifrit98 Jul 24, 2023
a753359
black time
ifrit98 Jul 25, 2023
ce572c0
indent
ifrit98 Jul 25, 2023
3497ef6
exclude /env
ifrit98 Jul 25, 2023
787f104
add missing black formatted files
ifrit98 Jul 25, 2023
57a1c8e
merge black_format into contrib update
ifrit98 Jul 25, 2023
b42ef3c
revert PR templates back to markdown from yaml
ifrit98 Jul 25, 2023
cfaf66b
revamp magicmock example to make more sense
ifrit98 Jul 25, 2023
eb0cd04
update debug to be more relevant, add tricks
ifrit98 Jul 25, 2023
0580884
address feedback RE PR steps and dev workflow
ifrit98 Jul 25, 2023
4058c93
update style guide to resolve tension between atomic commits and squa…
ifrit98 Jul 25, 2023
4300012
Merge branch 'release/5.3.2' into contrib_revamp
ifrit98 Jul 26, 2023
0f3df5a
catch missed merge conflict (formatting)
ifrit98 Jul 26, 2023
de1070d
black format again
ifrit98 Jul 26, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ version: 2.1

orbs:
python: circleci/[email protected]
python-lib: dialogue/[email protected]
# coveralls: coveralls/[email protected]

jobs:

black:
resource_class: small
parameters:
Expand Down
31 changes: 0 additions & 31 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Bug report
description: Create a report to help us improve
labels: [bug]
assignees: []

body:
- type: textarea
id: bug-description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
validations:
required: true

- type: textarea
id: reproduce
attributes:
label: To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. Go to '...'
2. Run command '...'
3. Scroll down to '....'
4. See error
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true

- type: textarea
id: screenshots
attributes:
label: Screenshots
description: If applicable, add screenshots to help explain your problem.
validations:
required: false

- type: input
id: environment
attributes:
label: Environment
description: Please specify your OS and Distro, and Bittensor Version.
placeholder: "OS and Distro: [e.g. Linux Ubuntu, Linux Fedora, etc.], Bittensor Version [e.g. 22]"
validations:
required: true

- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context about the problem here.
validations:
required: false
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Feature request
description: Suggest an idea for this project
labels: [feature]
assignees: []

body:
- type: textarea
id: problem-description
attributes:
label: Is your feature request related to a problem? Please describe.
description: A clear and concise description of what the problem is.
placeholder: "Ex. I'm always frustrated when [...]"
validations:
required: true

- type: textarea
id: solution
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
validations:
required: false
118 changes: 62 additions & 56 deletions .github/PULL_REQUEST_TEMPLATE/bug_fix.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,62 @@
### Requirements for Contributing a Bug Fix

* Fill out the template below. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
* The pull request must only fix an existing bug. To contribute other changes, you must use a different template. You can see all templates at <https://github.com/opentensor/bittensor/tree/master/.github/PULL_REQUEST_TEMPLATE>.
* The pull request must update the test suite to demonstrate the changed functionality.
* After you create the pull request, all status checks must pass before a maintainer reviews your contribution. This means that all the tests must pass your pull request before a maintainer is tagged to review.

### Identify the Bug

<!--

Link to the issue describing the bug that you're fixing.

If there is not yet an issue for your bug, please open a new issue and then link to that issue in your pull request.
Note: In some cases, one person's "bug" is another person's "feature." If the pull request does not address an existing issue with the "bug" label, the maintainers have the final say on whether the current behavior is a bug.

-->

### Description of the Change

<!--

We must be able to understand the design of your change from this description. If we can't get a good idea of what the code will be doing from the description here, the pull request may be closed at the maintainers' discretion. Keep in mind that the maintainer reviewing this PR may not be familiar with or have worked with the code here recently, so please walk us through the concepts.

-->


### Possible Drawbacks

<!-- What are the possible side-effects or negative impacts of the code change? -->

### Verification Process

<!--

What process did you follow to verify that the change has not introduced any regressions? Describe the actions you performed (including buttons you clicked, text you typed, commands you ran, etc.), and describe the results you observed.

-->

### Release Notes

<!--

Please describe the changes in a single line that explains this improvement in
terms that a user can understand. This text will be used in Atom's release notes.

If this change is not user-facing or notable enough to be included in release notes
you may use the strings "Not applicable" or "N/A" here.

Examples:

- The GitHub package now allows you to add co-authors to commits.
- Fixed an issue where multiple cursors did not work in a file with a single line.
- Increased the performance of searching and replacing across a whole project.

-->
name: Bug Fix Contribution
description: Use this template when contributing a bug fix.
labels: [bug, pull request]

body:
- type: markdown
attributes:
value: |
### Requirements for Contributing a Bug Fix

* Fill out the template below. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
* The pull request must only fix an existing bug. To contribute other changes, you must use a different template. You can see all templates at <https://github.com/atom/.github/tree/master/.github/PULL_REQUEST_TEMPLATE>.
* The pull request must update the test suite to demonstrate the changed functionality. For guidance, please see <https://flight-manual.atom.io/hacking-atom/sections/writing-specs/>.
* After you create the pull request, all status checks must be pass before a maintainer reviews your contribution. For more details, please see <https://github.com/atom/.github/tree/master/CONTRIBUTING.md#pull-requests>.

- type: input
id: bug
attributes:
label: Identify the Bug
description: Link to the issue describing the bug that you're fixing.
validations:
required: true

- type: textarea
id: change
attributes:
label: Description of the Change
description: We must be able to understand the design of your change from this description.
validations:
required: true

- type: textarea
id: alternate
attributes:
label: Alternate Designs
description: Explain what other alternates were considered and why the proposed version was selected.
validations:
required: false

- type: textarea
id: drawbacks
attributes:
label: Possible Drawbacks
description: What are the possible side-effects or negative impacts of the code change?
validations:
required: false

- type: textarea
id: verification
attributes:
label: Verification Process
description: What process did you follow to verify that the change has not introduced any regressions?
validations:
required: true

- type: input
id: release-notes
attributes:
label: Release Notes
description: Please describe the changes in a single line that explains this improvement in terms that a user can understand.
validations:
required: true
16 changes: 10 additions & 6 deletions .github/PULL_REQUEST_TEMPLATE/feature_change.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,22 @@

* Fill out the template below. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
* The pull request must contribute a change that has been endorsed by the maintainer team. See details in the template below.
* The pull request must update the test suite to exercise the updated functionality.
* After you create the pull request, all status checks must pass before a maintainer reviews your contribution. This means that all the tests must pass your pull request before a maintainer is tagged to review.
* The pull request must update the test suite to exercise the updated functionality. For guidance, please see <https://flight-manual.atom.io/hacking-atom/sections/writing-specs/>.
* After you create the pull request, all status checks must be pass before a maintainer reviews your contribution. For more details, please see <https://github.com/atom/.github/tree/master/CONTRIBUTING.md#pull-requests>.

### Issue Endorsed by Bittensor's Maintainers
### Issue or RFC Endorsed by Atom's Maintainers

<!--

Link to the issue that your change relates to.
Link to the issue or RFC that your change relates to. This must be one of the following:

To contribute an enhancement that isn't covered by one of the items above, please follow our guide for suggesting an enhancement: https://github.com/opentensor/bittensor/blob/master/CONTRIBUTING.md#suggesting-enhancements
* An open issue with the `help-wanted` label
* An open issue with the `triaged` label
* An RFC with "accepted" status

To contribute other changes, you must use a different template. You can see all templates at https://github.com/opentensor/bittensor/tree/master/.github/PULL_REQUEST_TEMPLATE.
To contribute an enhancement that isn't covered by one of the items above, please follow our guide for suggesting an enhancement: https://github.com/atom/.github/blob/master/CONTRIBUTING.md#suggesting-enhancements

To contribute other changes, you must use a different template. You can see all templates at https://github.com/atom/.github/tree/master/.github/PULL_REQUEST_TEMPLATE.

-->

Expand Down
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE/performance_improvement.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
### Requirements for Contributing a Performance Improvement

* Fill out the template below. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
* The pull request must only affect performance of existing functionality. To contribute other changes, you must use a different template. You can see all templates at <https://github.com/opentensor/bittensor/tree/master/.github/PULL_REQUEST_TEMPLATE>.
* After you create the pull request, all status checks must pass before a maintainer reviews your contribution. This means that all the tests must pass your pull request before a maintainer is tagged to review.
* The pull request must only affect performance of existing functionality. To contribute other changes, you must use a different template. You can see all templates at <https://github.com/atom/.github/tree/master/.github/PULL_REQUEST_TEMPLATE>.
* After you create the pull request, all status checks must be pass before a maintainer reviews your contribution. For more details, please see <https://github.com/atom/.github/tree/master/CONTRIBUTING.md#pull-requests>.

### Description of the Change

Expand All @@ -16,7 +16,7 @@ We must be able to understand the design of your change from this description. I

<!--

Describe the exact performance improvement observed (for example, reduced time to complete an operation, reduced memory use, model metrics improvements, etc.). Describe how you measured this change. Bonus points for including graphs that demonstrate the improvement or attached dumps from the built-in profiling tools. Using Tensorboard to show your improvements would be a great way to do this.
Describe the exact performance improvement observed (for example, reduced time to complete an operation, reduced memory use, etc.). Describe how you measured this change. Bonus points for including graphs that demonstrate the improvement or attached dumps from the built-in profiling tools.

-->

Expand Down
Loading