-
Notifications
You must be signed in to change notification settings - Fork 39
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
Update contributing guidelines #2018
Merged
Merged
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
74d57fb
Update contributing guidelines and PR template
kamilsa d5cfb3e
Mention stack trace and core dump in bugs reporting
kamilsa 6bad916
Mention that zombienet tests should be passing
kamilsa ac0a4ca
Add references documention
kamilsa d64de20
Merge branch 'master' into docs/contributing
kamilsa 8457231
Add issue templates
kamilsa 88a2a2c
Merge remote-tracking branch 'origin/docs/contributing' into docs/con…
kamilsa cf9de4c
Update bug_report.yml, add config.yml, enhancement.yml
kamilsa a43484a
Fix bug_report.yml and feature_request.yml
kamilsa c5cfe44
Update labels
kamilsa fb1fc23
Update Yes/No in PR template
kamilsa 8a69393
Merge branch 'master' into docs/contributing
kamilsa 99dfe84
Add empty lines at the end
kamilsa 4840b28
Merge remote-tracking branch 'origin/docs/contributing' into docs/con…
kamilsa File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,80 @@ | ||
name: Bug report | ||
description: Create a bug report to help us improve the project | ||
title: "[Bug]: " | ||
labels: ["bug"] | ||
projects: ["qdrvm/1"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
## Bug Report | ||
|
||
Before you submit a bug report, please ensure that: | ||
|
||
- The bug has not already been reported in the project. | ||
- You have searched the existing issues to make sure the bug has not already been reported. | ||
|
||
If the above conditions are met, please fill out the following information. | ||
|
||
- type: input | ||
id: bug-summary | ||
attributes: | ||
label: Bug Summary | ||
description: Provide a brief summary of the bug. | ||
placeholder: e.g., "Error occurs when..." | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: bug-description | ||
attributes: | ||
label: Bug Description | ||
description: Provide a detailed description of the bug. | ||
placeholder: Describe the bug in detail... | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: bug-reproduction | ||
attributes: | ||
label: Steps to Reproduce | ||
description: Provide detailed steps to reproduce the bug. Explain what command was executed to start the node, what mode (validator, sync node, etc.) was used, how many nodes were running, etc. | ||
placeholder: e.g., "1. Start the node with the following command..." | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: bug-effects | ||
attributes: | ||
label: Effects of the Bug | ||
description: Explain the effects of the bug, including any incorrect behavior, error messages, logs, stack traces, core dumps, etc. | ||
placeholder: e.g., "The application crashes with the error message..." | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: bug-expected-behavior | ||
attributes: | ||
label: Expected Behavior | ||
description: Describe what you expected to happen. | ||
placeholder: e.g., "I expected the application to..." | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
id: bug-system-info | ||
attributes: | ||
label: System Information | ||
description: Provide information about your system, such as OS, compiler, and docker image version or project version (or commit hash). | ||
placeholder: e.g., OS, Compiler, Project Version | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: bug-additional-context | ||
attributes: | ||
label: Additional Context | ||
description: Add any other context about the problem here. | ||
placeholder: e.g., "This bug only seems to occur when..." | ||
validations: | ||
required: false |
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 @@ | ||
blank_issues_enabled: false |
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,28 @@ | ||
name: Enhancement for KAGOME | ||
description: Suggest an improvement to an existing feature in the KAGOME project. | ||
title: "[Bug]: " | ||
labels: ["Enhancement"] | ||
projects: ["qdrvm/1"] | ||
body: | ||
- type: textarea | ||
attributes: | ||
label: Description | ||
description: Describe the enhancement that you are proposing for the KAGOME project. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Motivation | ||
description: Explain why this enhancement is beneficial | ||
validations: | ||
required: true | ||
- type: dropdown | ||
attributes: | ||
label: Are you planning to do it yourself in a pull request ? | ||
description: Any contribution is greatly appreciated. We are more than happy to provide help on the process. | ||
options: | ||
- "Yes" | ||
- "No" | ||
- Maybe | ||
validations: | ||
required: true |
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,56 @@ | ||
name: Feature request | ||
description: Suggest a new feature for the KAGOME project | ||
title: "[Feature Request]: " | ||
projects: ["qdrvm/1"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
## Feature Request | ||
|
||
Before you submit a feature request, please ensure that: | ||
|
||
- The feature does not already exist in the project. | ||
- The feature is aligned with the project's goals and roadmap. | ||
- You have searched the existing issues to make sure the feature has not already been requested. | ||
|
||
If the above conditions are met, please fill out the following information. | ||
|
||
- type: dropdown | ||
id: feature-type | ||
attributes: | ||
label: Component | ||
description: Select the component that this feature request is related to. | ||
options: | ||
- Grandpa | ||
- Babe | ||
- Parachains validation | ||
- Runtime | ||
- Host functions | ||
- Network | ||
- RPC | ||
- Storage | ||
- Transaction pool | ||
- Off-chain workers | ||
- Consensus | ||
- Utilities | ||
- Other | ||
default: 12 # index of "Other" | ||
|
||
- type: textarea | ||
id: feature-description | ||
attributes: | ||
label: Feature Description | ||
description: Provide a detailed description of the feature. Mention benefits this feature will bring to the project and its users or developers. | ||
placeholder: Describe the feature in detail... | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: feature-additional-info | ||
attributes: | ||
label: References and additional Information | ||
description: Add any references (e.g. to specification or existing implementation in other repos) or additional information that may be relevant to the feature request. | ||
placeholder: e.g., "This feature is important because..." | ||
validations: | ||
required: false |
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
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,52 @@ | ||
# Code of Conduct | ||
|
||
## 1. Purpose | ||
|
||
A primary goal of open-sourcing KAGOME is to be inclusive to the largest number of contributors, with the most varied and diverse backgrounds possible. As such, we are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, ability, ethnicity, socioeconomic status, and religion (or lack thereof). | ||
|
||
## 2. Expected Behavior | ||
|
||
The following behaviors are expected and requested of all community members: | ||
|
||
- Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community. | ||
- Exercise consideration and respect in your speech and actions. | ||
- Attempt collaboration before conflict. | ||
- Refrain from demeaning, discriminatory, or harassing behavior and speech. | ||
- Be mindful of your surroundings and of your fellow participants. | ||
|
||
## 3. Unacceptable Behavior | ||
|
||
The following behaviors are considered harassment and are unacceptable within our community: | ||
|
||
- Violence, threats of violence or violent language directed against another person. | ||
- Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language. | ||
- Posting or displaying sexually explicit or violent material. | ||
- Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability. | ||
|
||
## 4. Consequences of Unacceptable Behavior | ||
|
||
Unacceptable behavior from any community member will not be tolerated. Anyone asked to stop unacceptable behavior is expected to comply immediately. | ||
|
||
If a community member engages in unacceptable behavior, the project maintainers may take any action they deem appropriate, up to and including a temporary ban or permanent expulsion from the community without warning. | ||
|
||
## 5. Reporting Guidelines | ||
|
||
If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community moderator as soon as possible. | ||
|
||
## 6. Addressing Grievances | ||
|
||
If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify the project maintainers with a concise description of your grievance. | ||
|
||
## 7. Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. | ||
|
||
## 8. Contact info | ||
|
||
Quadrivium Numera Pte. Ltd. can be reached at github[at]qdrvm.io | ||
|
||
## 9. License and attribution | ||
|
||
This Code of Conduct is distributed under a Creative Commons Attribution-ShareAlike license. | ||
|
||
Portions of text derived from the [Django Code of Conduct](https://www.djangoproject.com/conduct/) and the [Geek Feminism Anti-Harassment Policy](http://geekfeminism.wikia.com/wiki/Conference_anti-harassment/Policy). |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
May be it is already done. If not, then I suggest to set up a redirect for all incoming mail from this address to someone's primary email, otherwise there is a chance of missing something or not being on time.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, we do redirect messages from this email to the employees email