Skip to content
This repository was archived by the owner on Mar 2, 2022. It is now read-only.

Commit e0c17da

Browse files
committed
Add code of conduct and contributing info
1 parent c4d9885 commit e0c17da

File tree

2 files changed

+84
-0
lines changed

2 files changed

+84
-0
lines changed

CODE_OF_CONDUCT.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Open Source Code of Conduct
2+
3+
## Our Pledge
4+
5+
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.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
Using welcoming and inclusive language
12+
Being respectful of differing viewpoints and experiences
13+
Gracefully accepting constructive criticism
14+
Focusing on what is best for the community
15+
Showing empathy towards other community members
16+
Examples of unacceptable behavior by participants include:
17+
18+
The use of sexualized language or imagery and unwelcome sexual attention or advances
19+
Trolling, insulting/derogatory comments, and personal or political attacks
20+
Public or private harassment
21+
Publishing others’ private information, such as a physical or electronic address, without explicit permission
22+
Other conduct which could reasonably be considered inappropriate in a professional setting
23+
24+
## Our Responsibilities
25+
26+
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.
27+
28+
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.
29+
30+
## Scope
31+
32+
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.
33+
34+
## Enforcement
35+
36+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. 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.
37+
38+
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.
39+
40+
## Attribution
41+
42+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
43+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
44+
45+
[homepage]: https://www.contributor-covenant.org

CONTRIBUTING.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Contributing to python-compiler
2+
We want to make contributing to this project as easy and transparent as
3+
possible.
4+
5+
## Our Development Process
6+
... (in particular how this is synced with internal changes to the project)
7+
8+
## Pull Requests
9+
We actively welcome your pull requests.
10+
11+
1. Fork the repo and create your branch from `master`.
12+
2. If you've added code that should be tested, add tests.
13+
3. If you've changed APIs, update the documentation.
14+
4. Ensure the test suite passes.
15+
5. Make sure your code lints.
16+
6. If you haven't already, complete the Contributor License Agreement ("CLA").
17+
18+
## Contributor License Agreement ("CLA")
19+
In order to accept your pull request, we need you to submit a CLA. You only need
20+
to do this once to work on any of Facebook's open source projects.
21+
22+
Complete your CLA here: <https://code.facebook.com/cla>
23+
24+
## Issues
25+
We use GitHub issues to track public bugs. Please ensure your description is
26+
clear and has sufficient instructions to be able to reproduce the issue.
27+
28+
Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe
29+
disclosure of security bugs. In those cases, please go through the process
30+
outlined on that page and do not file a public issue.
31+
32+
## Coding Style
33+
* Black
34+
* Type annotated
35+
* The existing code doesn't fully conform to this, but we are working towards it!
36+
37+
## License
38+
By contributing to contributing, you agree that your contributions will be licensed
39+
under the LICENSE file in the root directory of this source tree.

0 commit comments

Comments
 (0)