Skip to content
This repository was archived by the owner on Jan 13, 2023. It is now read-only.

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-Authored-By: Phoenix <[email protected]>
  • Loading branch information
JakeSCahill and todofixthis authored Mar 17, 2020
1 parent 6916516 commit 459e684
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
10 changes: 5 additions & 5 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ This section guides you through suggesting a new feature. Following these guidel

To suggest a new feature, talk to the IOTA community and IOTA Foundation members on [Discord](https://discord.iota.org/).

If the team members approves your feature, they will create an issue for it.
If the team members approve your feature, they will create an issue for it.
</details>

<br>
Expand All @@ -94,7 +94,7 @@ Otherwise, your feature may not be approved at all.

### Building a new feature

To build a new feature, check out a new branch based on the `master` branch, and be sure to consider the following:
To build a new feature, check out a new branch based on the `develop` branch, and be sure to consider the following:

- If the feature has a public facing API, make sure to document it, using [Sphinx](https://www.sphinx-doc.org/en/master/) code comments

Expand Down Expand Up @@ -129,7 +129,7 @@ When creating a pull request, please follow these steps to have your contributio

**Note:** Minor changes such as fixing a typo can but do not need an open issue.

- All code should be well tested
- All code should include comprehensive unit tests.

### Submitting a pull request

Expand All @@ -142,7 +142,7 @@ The following is a typical workflow for submitting a new pull request:

If all [status checks](https://help.github.com/articles/about-status-checks/) pass, and the maintainer approves the PR, it will be merged.

**Note:** Reviewers may ask you to complete additional work, tests, or other changes before your pull request can be approved and merged.
**Note:** Reviewers may request changes before your pull request can be approved and merged.
</details>

<br>
Expand All @@ -151,4 +151,4 @@ If all [status checks](https://help.github.com/articles/about-status-checks/) pa
<summary>Code of Conduct :clipboard:</summary>
<br>

This project and everyone participating in it is governed by the [IOTA Code of Conduct](CODE_OF_CONDUCT.md).
This project and everyone participating in it are governed by the [IOTA Code of Conduct](CODE_OF_CONDUCT.md).
5 changes: 3 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ Briefly describe the bug.

Which version of the library are you running?

- Version:
- PyOTA Version:
- Python Version:

## IOTA network

Expand Down Expand Up @@ -48,4 +49,4 @@ Describe what actually happens.

## Errors

Paste any errors that you see.
Paste here any error messages and/or stacktraces that you see.
7 changes: 3 additions & 4 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

At the IOTA Foundation, we consider the security of our systems a top priority. But no matter how much effort we put into system security, there can still be vulnerabilities present. If you've discovered a vulnerability, please follow the guidelines below to report it to our security team:
<ul>
<li>E-mail your findings to [email protected]. If the report contains highly sensitive information, please consider encrypting your findings using our [email protected] (466385BD0B40D9550F93C04746A440CCE5664A64) PGP key.</li>
<li>E-mail your findings to [email protected]. If the report contains highly sensitive information, please consider encrypting your findings using our [email protected] PGP key (fingerprint 466385BD0B40D9550F93C04746A440CCE5664A64).</li>
</ul>
Please follow these rules when testing/reporting vulnerabilities:
<ul>
<li>Do not take advantage of the vulnerability you have discovered, for example by downloading more data than is necessary to demonstrate the vulnerability.</li>
<li>Do not read, modify or delete data that isn't your own.</li>
<li>We ask that you do not to disclosure the problem to third parties until it has been resolved.</li>
<li>The scope of the program is limited to technical vulnerabilities in IOTA Foundations's web applications and open source software packages distributed through GitHub, please do not try to test physical security or attempt phishing attacks against our employees, and so on.</li>
<li>We ask that you not disclose the problem to third parties until it has been resolved.</li>
<li>The scope of the program is limited to technical vulnerabilities in IOTA Foundations's web applications and open source software packages distributed through GitHub please do not try to test physical security or attempt phishing attacks against our employees, and so on.</li>
<li>Out of concern for the availability of our services to all users, please do not attempt to carry out DoS attacks, leverage black hat SEO techniques, spam people, and do other similarly questionable things. We also discourage the use of any vulnerability testing tools that automatically generate significant volumes of traffic.</li>
</ul>
What we promise:
Expand All @@ -20,4 +20,3 @@ What we promise:
<li>To show our appreciation for your effort and cooperation during the report, we will list your name and a link to a personal website/social network profile on the page below so that the public can know you've helped keep the IOTA Foundation secure.</li>
</ul>
We sincerely appreciate the efforts of security researchers in keeping our community safe.

0 comments on commit 459e684

Please sign in to comment.