-
Notifications
You must be signed in to change notification settings - Fork 213
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from enigmampc/master
Upgrade the Secret Network repo
- Loading branch information
Showing
35 changed files
with
1,736 additions
and
272 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
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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,84 @@ | ||
# Contributing to Secret Network | ||
|
||
First of all, thanks for being here! Our intention is to be as transparent and collaborative as possible, and we hope you enjoy building secret contracts and secret apps. We are so grateful to the amazing people who make invaluable contributions to this open-source project and its ecosystem. | ||
|
||
The following is a set of guidelines for contributing to Secret Network and its resources, which are hosted in the [Enigma Organization](https://github.com/enigmampc) on GitHub. Use your best judgment, and feel free to propose changes to this document in a pull request. | ||
|
||
## How May I Contribute? | ||
|
||
### Follow the Code of Conduct | ||
|
||
This open-source project is governed by the [Secret Network Code of Conduct](https://github.com/enigmampc/SecretNetwork/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. | ||
|
||
### Participate in the Community | ||
|
||
We have a [forum](https://forum.scrt.network) and a [wiki](https://learn.scrt.network), plus a [RocketChat](https://chat.scrt.network) where members of the community might offer helpful advice if you have ideas or questions. | ||
|
||
### Report Bugs | ||
|
||
This section walks you through submitting a bug report for Secret Network. Following these guidelines helps maintainers and other members of the community understand your report :pencil:, reproduce the behavior :computer:, and find related reports :mag_right:. | ||
|
||
Before creating bug reports, please check [this list](#before-submitting-a-bug-report) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out [the required template](ISSUE_TEMPLATES/bug_report.md), the information it asks for helps us resolve issues faster. | ||
|
||
> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one. | ||
#### Before Submitting A Bug Report | ||
|
||
* **Check [the FAQs](https://learn.scrt.network/questions)** for a list of commonly asked questions and our best answers. | ||
* **Look through recent posts on [the forum](https://forum.scrt.network)** to see any relevant discussions. | ||
* **Perform a [search](https://github.com/search?q=+is%3Aissue+user%3Aenigmampc)** to see if the problem has already been reported. | ||
|
||
#### How Do I Submit A (Good) Bug Report? | ||
|
||
Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). After you've determined which repository the bug is related to, create an issue in that repository using [the template](ISSUE_TEMPLATES/bug_report.md). | ||
|
||
Explain the problem and include additional details to help maintainers reproduce the problem: | ||
|
||
* **Use a clear and descriptive title** for the issue to identify the problem. | ||
* **Describe the exact steps which reproduce the problem** in as many details as possible. | ||
* **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. | ||
* **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior. | ||
* **Explain which behavior you expected to see instead and why.** | ||
* **Include screenshots** which clearly demonstrate the problem. | ||
* **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened. | ||
|
||
### Suggest Enhancements | ||
|
||
This section guides you through submitting an enhancement suggestion for Secret Network, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion :pencil: and find related suggestions :mag_right:. | ||
|
||
When you are creating your enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Please use [this template](ISSUE_TEMPLATES/feature_request.md), including the steps that you would take if the feature existed. | ||
|
||
#### How Do I Submit A (Good) Enhancement Suggestion? | ||
|
||
Enhancement suggestions are tracked as [issues](https://guides.github.com/features/issues) in our [GitHub project boards](https://github.com/enigmampc/SecretNetwork/projects). Create an issue in [this repository](https://github.com/enigmampc/SecretNetwork) and follow these guidelines: | ||
|
||
* **Use a clear and descriptive title** for the issue to identify the suggestion. | ||
* **Provide a step-by-step description of the suggested enhancement** with as many details of the benefits and requirements as possible. | ||
* **Provide specific examples to demonstrate the steps**. Include snippets which you use in those examples, as [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines). | ||
* **Describe the current behavior** and **explain which behavior you expected to see instead** and why. | ||
* **Include screenshots** which help you demonstrate the steps or point out the relevant part of Secret Network that is affected. | ||
* **Explain why this enhancement would be useful** to most Secret Network users and isn't something that can or should be implemented as a community project. | ||
|
||
### Your First Code Contribution | ||
|
||
Unsure where to begin contributing to Secret Network? | ||
|
||
You can start by looking through the [open issues labeled `help-wanted`](https://github.com/enigmampc/SecretNetwork/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+). | ||
|
||
If you want to learn more about Secret Network and how to build secret contracts and secret apps, the [full documentation](https://build.scrt.network) is available online. You can find the source to the docs in [this repository](https://github.com/enigmampc/SecretNetwork/docs). | ||
|
||
### Submit Pull Requests | ||
|
||
The process described here has several goals: | ||
|
||
- Maintain Secret Network's quality. | ||
- Fix problems that are important to users. | ||
- Engage the community in working toward the best possible Secret Network. | ||
- Enable a sustainable system for Secret Network's maintainers to review contributions. | ||
|
||
Please follow these steps to have your contribution considered by the maintainers: | ||
|
||
1. Choose from the list of [templates](PULL_REQUEST_TEMPLATES/PULL_REQUEST_TEMPLATE.md) and follow all instructions. | ||
2. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks) are passing. | ||
|
||
Keep in mind, the reviewer(s) may ask you to complete additional changes before your pull request can be accepted. |
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,45 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
|
||
--- | ||
|
||
<!-- | ||
Have you read Secret Network's Code of Conduct? By filing an Issue, you are expected to comply with it, including treating everyone with respect: https://github.com/enigmampc/SecretNetwork/CODE_OF_CONDUCT.md | ||
Do you want to ask a question? Are you looking for support? The Secret Network Forum is the best place to get support: https://forum.scrt.network | ||
--> | ||
|
||
### Prerequisites | ||
|
||
* [Ask questions in the RocketChat](https://chat.scrt.network) | ||
* [Look through recent posts on the forum](https://forum.scrt.network) | ||
* [Check issues that have already been filed](https://github.com/issues?utf8=✓&q=is%3Aissue+user%3Aenigmampc) | ||
|
||
### Description | ||
|
||
<!-- Description of the issue --> | ||
|
||
### Steps to Reproduce | ||
|
||
1. <!-- First Step --> | ||
2. <!-- Second Step --> | ||
3. <!-- and so on… --> | ||
|
||
**Expected behavior:** | ||
|
||
<!-- What you expect to happen --> | ||
|
||
**Actual behavior:** | ||
|
||
<!-- What actually happens --> | ||
|
||
**Reproduces how often:** | ||
|
||
<!-- What percentage of the time does it reproduce? --> | ||
|
||
### Additional Information | ||
|
||
<!-- Any additional information, configuration or data that might be necessary to reproduce the issue. --> |
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,29 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
|
||
--- | ||
|
||
<!-- | ||
Have you read Secret Network's Code of Conduct? By filing an Issue, you are expected to comply with it, including treating everyone with respect: https://github.com/enigmampc/SecretNetwork/CODE_OF_CONDUCT.md | ||
Do you want to ask a question? Are you looking for support? The Secret Network Forum is the best place to get support: https://forum.scrt.network | ||
--> | ||
|
||
## Summary | ||
|
||
<!-- One paragraph explanation of the feature. --> | ||
|
||
## Motivation | ||
|
||
<!-- Why are we doing this? What use cases does it support? What is the expected outcome? --> | ||
|
||
## Describe alternatives you've considered | ||
|
||
<!-- A clear and concise description of the alternative solutions you've considered. Be sure to explain why Secret Network's existing customizability isn't suitable for this feature. --> | ||
|
||
## Additional context | ||
|
||
<!-- Add any other content about the feature request 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,10 @@ | ||
👋 Hello there! Welcome. Please follow the steps below to tell us about your contribution. | ||
|
||
1. Use the correct template for your contribution: | ||
- 🐛 [Fixing a Bug](bug_fix.md) | ||
- 📈 [Improving Performance](improve_performance.md) | ||
- 📝 [Updating Documentation](update_docs.md) | ||
- 💻 [Changing Functionality](change_functionality.md) | ||
2. Replace text with the contents of the template | ||
3. Fill in all sections of the template | ||
4. Click "Create pull request" |
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,49 @@ | ||
### 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 [here](PULL_REQUEST_TEMPLATE.md). | ||
|
||
### 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. | ||
--> | ||
|
||
### Alternate Designs | ||
|
||
<!-- Explain what other alternates were considered and why the proposed version was selected --> | ||
|
||
### 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 Secret Network'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. | ||
--> |
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,44 @@ | ||
### Requirements for Adding, Changing, or Removing a Feature | ||
|
||
* 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. All templates [here](PULL_REQUEST_TEMPLATE.md). | ||
* After you create the pull request, all status checks must pass before a maintainer reviews your contribution. | ||
|
||
### 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. | ||
--> | ||
|
||
### Alternate Designs | ||
|
||
<!-- Explain what other alternates were considered and why the proposed version was selected --> | ||
|
||
### 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 your change has the desired effects? | ||
- How did you verify that all new functionality works as expected? | ||
- How did you verify that all changed functionality works as expected? | ||
- How did you 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 Secret Network'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. | ||
--> |
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,46 @@ | ||
### 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 [here](PULL_REQUEST_TEMPLATE.md). | ||
|
||
### 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. | ||
--> | ||
|
||
### Quantitative Performance Benefits | ||
|
||
<!-- | ||
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. | ||
--> | ||
|
||
### 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. | ||
--> | ||
|
||
### Applicable Issues | ||
|
||
<!-- Enter any applicable Issues here --> | ||
|
||
### 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 Secret Network'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. | ||
--> |
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 @@ | ||
### Requirements for Contributing Documentation | ||
|
||
* 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 contribute documentation (for example, markdown files or API docs). To contribute other changes, you must use a different template. You can see all templates [here](PULL_REQUEST_TEMPLATE.md). | ||
|
||
### Description of the Change | ||
|
||
<!-- | ||
We must be able to understand the purpose of your change from this description. If we can't get a good idea of the benefits of the change from the description here, the pull request may be closed at the maintainers' discretion. | ||
--> | ||
|
||
### 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 Secret Network'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. | ||
--> |
Oops, something went wrong.