From 523e502a33bca1ef9090cf4df12fb4fb4819ba65 Mon Sep 17 00:00:00 2001 From: Jessica Lin Date: Wed, 11 Nov 2020 13:59:57 -0800 Subject: [PATCH 1/6] Create CONTRIBUTING.md file --- CONTRIBUTING.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000000..46db198c3b4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,27 @@ +# Contributing to PyTorch Tutorials +We want to make contributing to this project as easy and transparent as +possible. + +## Pull Requests +We actively welcome your pull requests. + +1. Fork the repo and create your branch from `master`. +2. If you've added code that should be tested, add tests. +3. If you've changed APIs, update the documentation. +4. Ensure the test suite passes. +5. Make sure your code lints. +6. If you haven't already, complete the Contributor License Agreement ("CLA"). + +## Contributor License Agreement ("CLA") +In order to accept your pull request, we need you to submit a CLA. You only need +to do this once to work on any of Facebook's open source projects. + +Complete your CLA here: + +## Issues +We use GitHub issues to track public bugs. Please ensure your description is +clear and has sufficient instructions to be able to reproduce the issue. + +## License +By contributing to PyTorch, you agree that your contributions will be licensed +under the LICENSE file in the root directory of this source tree. From 0be55d83809e4a61dc08a78a0213d590c8a70b35 Mon Sep 17 00:00:00 2001 From: Jessica Lin Date: Wed, 11 Nov 2020 14:03:11 -0800 Subject: [PATCH 2/6] Add CONTRIBUTION to README --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5a9edf740ad..a6fab7f4e81 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,6 @@ All the tutorials are now presented as sphinx style documentation at: ## [https://pytorch.org/tutorials](https://pytorch.org/tutorials) - # Contributing We use sphinx-gallery's [notebook styled examples](https://sphinx-gallery.github.io/stable/tutorials/index.html) to create the tutorials. Syntax is very simple. In essence, you write a slightly well formatted python file and it shows up as documentation page. @@ -19,6 +18,8 @@ Here's how to create a new tutorial or recipe: In case you prefer to write your tutorial in jupyter, you can use [this script](https://gist.github.com/chsasank/7218ca16f8d022e02a9c0deb94a310fe) to convert the notebook to python file. After conversion and addition to the project, please make sure the sections headings etc are in logical order. +See the (CONTRIBUTION)[CONTRIBUTION.md] file to submit your changes a a pull request. + ## Building - Start with installing torch, torchvision, and your GPUs latest drivers. Install other requirements using `pip install -r requirements.txt` From 0ac165866b54f655011d8340bb423cd8f0cd84b9 Mon Sep 17 00:00:00 2001 From: Jessica Lin Date: Wed, 11 Nov 2020 14:05:04 -0800 Subject: [PATCH 3/6] Fix syntax --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a6fab7f4e81..67786999ebd 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Here's how to create a new tutorial or recipe: In case you prefer to write your tutorial in jupyter, you can use [this script](https://gist.github.com/chsasank/7218ca16f8d022e02a9c0deb94a310fe) to convert the notebook to python file. After conversion and addition to the project, please make sure the sections headings etc are in logical order. -See the (CONTRIBUTION)[CONTRIBUTION.md] file to submit your changes a a pull request. +See the [CONTRIBUTION](CONTRIBUTION.md) file to submit your changes a a pull request. ## Building From 33e29d0b72d1dd4ae72f56c417211ccc20df5c1d Mon Sep 17 00:00:00 2001 From: Jessica Lin Date: Wed, 11 Nov 2020 14:05:12 -0800 Subject: [PATCH 4/6] Fix syntax From bca3ef10880824afd48ef605edea273b2be305fb Mon Sep 17 00:00:00 2001 From: Jessica Lin Date: Wed, 11 Nov 2020 14:07:26 -0800 Subject: [PATCH 5/6] Create CODE_OF_CONDUCT.md --- CODE_OF_CONDUCT.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000000..50bf79cf054 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,45 @@ +# Open Source Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, 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. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment include: + +Using welcoming and inclusive language +Being respectful of differing viewpoints and experiences +Gracefully accepting constructive criticism +Focusing on what is best for the community +Showing empathy towards other community members +Examples of unacceptable behavior by participants include: + +The use of sexualized language or imagery and unwelcome sexual attention or advances +Trolling, insulting/derogatory comments, and personal or political attacks +Public or private harassment +Publishing others’ private information, such as a physical or electronic address, without explicit permission +Other conduct which could reasonably be considered inappropriate in a professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at opensource-conduct@fb.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org From 682fc841a55e7dc03982d00ec991c33a103a17e3 Mon Sep 17 00:00:00 2001 From: Jessica Lin Date: Wed, 11 Nov 2020 14:15:21 -0800 Subject: [PATCH 6/6] Add License --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 67786999ebd..d6e5fdc32af 100644 --- a/README.md +++ b/README.md @@ -30,3 +30,7 @@ See the [CONTRIBUTION](CONTRIBUTION.md) file to submit your changes a a pull req - You can skip the computationally intensive graph generation by running `make html-noplot` to build basic html documentation to `_build/html`. This way, you can quickly preview your tutorial. > If you get **ModuleNotFoundError: No module named 'pytorch_sphinx_theme' make: *** [html-noplot] Error 2**, from /tutorials/src/pytorch-sphinx-theme run `python setup.py install`. + +## License + +PyTorch is a BSD-style licensed, as found in the [LICENSE](LICENSE) file.