forked from ENOT-AutoDL/onnx2torch
-
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.
Scaffolding: security, contributions, and code of conduct (#6)
- Loading branch information
Showing
3 changed files
with
193 additions
and
0 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,96 @@ | ||
Contributor Covenant Code of Conduct | ||
Our Pledge | ||
We as members, contributors, and leaders pledge to make participation in our | ||
community a harassment-free experience for everyone, regardless of age, body | ||
size, visible or invisible disability, ethnicity, sex characteristics, gender | ||
identity and expression, level of experience, education, socio-economic status, | ||
nationality, personal appearance, race, religion, or sexual identity | ||
and orientation. | ||
We pledge to act and interact in ways that contribute to an open, welcoming, | ||
diverse, inclusive, and healthy community. | ||
Our Standards | ||
Examples of behavior that contributes to a positive environment for our | ||
community include: | ||
|
||
* Demonstrating empathy and kindness toward other people | ||
* Being respectful of differing opinions, viewpoints, and experiences | ||
* Giving and gracefully accepting constructive feedback | ||
* Accepting responsibility and apologizing to those affected by our mistakes, | ||
and learning from the experience | ||
* Focusing on what is best not just for us as individuals, but for the | ||
overall community | ||
|
||
Examples of unacceptable behavior include: | ||
|
||
* The use of sexualized language or imagery, and sexual attention or | ||
advances of any kind | ||
* Trolling, insulting or derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or email | ||
address, without their explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
Enforcement Responsibilities | ||
Community leaders are responsible for clarifying and enforcing our standards of | ||
acceptable behavior and will take appropriate and fair corrective action in | ||
response to any behavior that they deem inappropriate, threatening, offensive, | ||
or harmful. | ||
Community leaders have the right and responsibility to remove, edit, or reject | ||
comments, commits, code, wiki edits, issues, and other contributions that are | ||
not aligned to this Code of Conduct, and will communicate reasons for moderation | ||
decisions when appropriate. | ||
Scope | ||
This Code of Conduct applies within all community spaces, and also applies when | ||
an individual is officially representing the community in public spaces. | ||
Examples of representing our community include using an official e-mail address, | ||
posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. | ||
Enforcement | ||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported to the community leaders responsible for enforcement at | ||
this email address: [email protected]. | ||
All complaints will be reviewed and investigated promptly and fairly. | ||
All community leaders are obligated to respect the privacy and security of the | ||
reporter of any incident. | ||
Enforcement Guidelines | ||
Community leaders will follow these Community Impact Guidelines in determining | ||
the consequences for any action they deem in violation of this Code of Conduct: | ||
1. Correction | ||
Community Impact: Use of inappropriate language or other behavior deemed | ||
unprofessional or unwelcome in the community. | ||
Consequence: A private, written warning from community leaders, providing | ||
clarity around the nature of the violation and an explanation of why the | ||
behavior was inappropriate. A public apology may be requested. | ||
2. Warning | ||
Community Impact: A violation through a single incident or series | ||
of actions. | ||
Consequence: A warning with consequences for continued behavior. No | ||
interaction with the people involved, including unsolicited interaction with | ||
those enforcing the Code of Conduct, for a specified period of time. This | ||
includes avoiding interactions in community spaces as well as external channels | ||
like social media. Violating these terms may lead to a temporary or | ||
permanent ban. | ||
3. Temporary Ban | ||
Community Impact: A serious violation of community standards, including | ||
sustained inappropriate behavior. | ||
Consequence: A temporary ban from any sort of interaction or public | ||
communication with the community for a specified period of time. No public or | ||
private interaction with the people involved, including unsolicited interaction | ||
with those enforcing the Code of Conduct, is allowed during this period. | ||
Violating these terms may lead to a permanent ban. | ||
4. Permanent Ban | ||
Community Impact: Demonstrating a pattern of violation of community | ||
standards, including sustained inappropriate behavior, harassment of an | ||
individual, or aggression toward or disparagement of classes of individuals. | ||
Consequence: A permanent ban from any sort of public interaction within | ||
the community. | ||
Attribution | ||
This Code of Conduct is adapted from the Contributor Covenant, | ||
version 2.0, available at | ||
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. | ||
Community Impact Guidelines were inspired by Mozilla's code of conduct | ||
enforcement ladder. | ||
For answers to common questions about this code of conduct, see the FAQ at | ||
https://www.contributor-covenant.org/faq. Translations are available at | ||
https://www.contributor-covenant.org/translations. |
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,79 @@ | ||
# Contributing | ||
|
||
## Introduction | ||
|
||
We appreciate your interest in considering contributing to onnx2torch2. Community contributions mean a lot to us. | ||
|
||
## Contributions we need | ||
|
||
You may already know how you'd like to contribute, whether it's a fix for a bug you | ||
encountered, or a new feature your team wants to use. | ||
|
||
If you don't know where to start, consider improving | ||
documentation, bug triaging, and writing tutorials are all examples of | ||
helpful contributions that mean less work for you. | ||
|
||
## Your First Contribution | ||
|
||
Unsure where to begin contributing? You can start by looking through either of these two issue lists: | ||
|
||
* [help-wanted | ||
issues](https://github.com/untetherai/onnx2torch2/issues?q=is%3Aopen+is%3Aissue+label%3ahelp-wanted) | ||
* [good-first-issue issues](https://github.com/untetherai/onnx2torch2/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22) | ||
|
||
Never contributed to open source before? Here are a couple of friendly | ||
tutorials: | ||
|
||
- <http://makeapullrequest.com/> | ||
- <http://www.firsttimersonly.com/> | ||
|
||
## Getting Started | ||
|
||
Here's how to get started with your code contribution: | ||
|
||
1. Create your own fork of onnx2torch2 | ||
2. Do the changes in your fork | ||
3. | ||
*Create a virtualenv and install the development dependencies from the dev_requirements.txt file:* | ||
|
||
a. python -m venv .venv | ||
b. source .venv/bin/activate | ||
c. pip install .[dev] | ||
|
||
5. While developing, make sure the tests pass by running `pytest -s` | ||
6. If you like the change and think the project could use it, send a | ||
pull request | ||
|
||
### Security Vulnerabilities | ||
|
||
**NOTE**: If you find a security vulnerability, do NOT open an issue. | ||
Email [Untether Open Source (<[email protected]>)](mailto:[email protected]) instead. | ||
|
||
In order to determine whether you are dealing with a security issue, ask | ||
yourself these two questions: | ||
|
||
- Can I access something that's not mine, or something I shouldn't | ||
have access to? | ||
- Can I disable something for other people? | ||
|
||
If the answer to either of those two questions are *yes*, then you're | ||
probably dealing with a security issue. Note that even if you answer | ||
*no* to both questions, you may still be dealing with a security | ||
issue, so if you're unsure, just email [us](mailto:[email protected]). | ||
|
||
## Suggest a feature or enhancement | ||
|
||
If you'd like to contribute a new feature, make sure you check our | ||
issue list to see if someone has already proposed it. Work may already | ||
be underway on the feature you want or we may have rejected a | ||
feature like it already. | ||
|
||
If you don't see anything, open a new issue that describes the feature | ||
you would like and how it should work. | ||
|
||
## Code review process | ||
|
||
The core team regularly looks at pull requests. We will provide | ||
feedback as soon as possible. After receiving our feedback, please respond | ||
within two weeks. After that time, we may close your PR if it isn't | ||
showing any activity. |
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,18 @@ | ||
# Reporting a vulnerability | ||
|
||
## Introduction | ||
|
||
If you find a security vulnerability, do NOT open an issue. | ||
Email [Untether Open Source (<[email protected]>)](mailto:[email protected]) instead. We will work with you, to support a responsible disclosure. | ||
|
||
In order to determine whether you are dealing with a security issue, ask | ||
yourself these two questions: | ||
|
||
- Can I access something that's not mine, or something I shouldn't | ||
have access to? | ||
- Can I disable something for other people? | ||
|
||
If the answer to either of those two questions are *yes*, then you're | ||
probably dealing with a security issue. Note that even if you answer | ||
*no* to both questions, you may still be dealing with a security | ||
issue, so if you're unsure, just email [us](mailto:[email protected]). |