-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Project import generated by Copybara.
PiperOrigin-RevId: 318580209
- Loading branch information
0 parents
commit ea6a7f7
Showing
138 changed files
with
16,085 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,4 @@ | ||
bazel-* | ||
mediapipe/MediaPipe.xcodeproj | ||
mediapipe/MediaPipe.tulsiproj/*.tulsiconf-user | ||
mediapipe/provisioning_profile.mobileprovision |
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,93 @@ | ||
# Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, 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 both within project spaces and in public spaces | ||
when an individual is representing the project or its community. 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. | ||
|
||
This Code of Conduct also applies outside the project spaces when the Project | ||
Steward has a reasonable belief that an individual's behavior may have a | ||
negative impact on the project or its community. | ||
|
||
## Conflict Resolution | ||
|
||
We do not believe that all conflict is bad; healthy debate and disagreement | ||
often yield positive results. However, it is never okay to be disrespectful or | ||
to engage in behavior that violates the project’s code of conduct. | ||
|
||
If you see someone violating the code of conduct, you are encouraged to address | ||
the behavior directly with those involved. Many issues can be resolved quickly | ||
and easily, and this gives people more control over the outcome of their | ||
dispute. If you are unable to resolve the matter for any reason, or if the | ||
behavior is threatening or harassing, report it. We are dedicated to providing | ||
an environment where participants feel welcome and safe. | ||
|
||
Reports should be directed to Yusef Shafi ([email protected]), the | ||
Project Steward(s) for Pandemic Sim. It is the Project Steward’s duty to | ||
receive and address reported violations of the code of conduct. They will then | ||
work with a committee consisting of representatives from the Open Source | ||
Programs Office and the Google Open Source Strategy team. If for any reason you | ||
are uncomfortable reaching out to the Project Steward, please email | ||
[email protected]. | ||
|
||
We will investigate every complaint, but you may not receive a direct response. | ||
We will use our discretion in determining when and how to follow up on reported | ||
incidents, which may range from not taking action to permanent expulsion from | ||
the project and project-sponsored spaces. We will notify the accused of the | ||
report and provide them an opportunity to discuss it before any action is taken. | ||
The identity of the reporter will be omitted from the details of the report | ||
supplied to the accused. In potentially harmful situations, such as ongoing | ||
harassment or threats to anyone's safety, we may take action without notice. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, | ||
available at | ||
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html |
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,115 @@ | ||
# Contributing guidelines | ||
|
||
## Pull Request Checklist | ||
|
||
Before sending your pull requests, make sure you followed this list. | ||
|
||
- Read [contributing guidelines](CONTRIBUTING.md). | ||
- Read [Code of Conduct](CODE_OF_CONDUCT.md). | ||
- Ensure you have signed the | ||
[Contributor License Agreement (CLA)](https://cla.developers.google.com/). | ||
- Check if my changes are consistent with the | ||
[guidelines](https://github.com/google/agent_based_epidemic_sim/blob/master/CONTRIBUTING.md#general-guidelines-and-philosophy-for-contribution). | ||
- Changes are consistent with the | ||
[Coding Style](https://github.com/google/agent_based_epidemic_sim/blob/master/CONTRIBUTING.md#c-coding-style). | ||
- Run | ||
[Unit Tests](https://github.com/google/agent_based_epidemic_sim/blob/master/CONTRIBUTING.md#running-unit-tests). | ||
|
||
## How to become a contributor and submit your own code | ||
|
||
### Contributor License Agreements | ||
|
||
We'd love to accept your patches! Before we can take them, we have to jump a | ||
couple of legal hurdles. | ||
|
||
Please fill out either the individual or corporate Contributor License Agreement | ||
(CLA). | ||
|
||
* If you are an individual writing original source code and you're sure you | ||
own the intellectual property, then you'll need to sign an | ||
[individual CLA](https://code.google.com/legal/individual-cla-v1.0.html). | ||
* If you work for a company that wants to allow you to contribute your work, | ||
then you'll need to sign a | ||
[corporate CLA](https://code.google.com/legal/corporate-cla-v1.0.html). | ||
|
||
Follow either of the two links above to access the appropriate CLA and | ||
instructions for how to sign and return it. Once we receive it, we'll be able to | ||
accept your pull requests. | ||
|
||
***NOTE***: Only original source code from you and other people that have signed | ||
the CLA can be accepted into the main repository. | ||
|
||
### Contributing code | ||
|
||
If you have improvements to Agent Based Epidemic Sim, send us your pull | ||
requests! For those just getting started, GitHub has a | ||
[howto](https://help.github.com/articles/using-pull-requests/). | ||
|
||
Agent Based Epidemic Sim team members will be assigned to review your pull | ||
requests. Once the pull requests are approved and pass continuous integration | ||
checks, a Agent Based Epidemic Sim team member will apply `ready to pull` label | ||
to your change. This means we are working on getting your pull request submitted | ||
to our internal repository. After the change has been submitted internally, your | ||
pull request will be merged automatically on GitHub. | ||
|
||
If you want to contribute but you're not sure where to start, take a look at the | ||
[issues with the "contributions welcome" label](https://github.com/google/agent_based_epidemic_sim/labels/stat%3Acontributions%20welcome). | ||
These are issues that we believe are particularly well suited for outside | ||
contributions, often because we probably won't get to them right now. If you | ||
decide to start on an issue, leave a comment so that other people know that | ||
you're working on it. If you want to help out, but not alone, use the issue | ||
comment thread to coordinate. | ||
|
||
### Contribution guidelines and standards | ||
|
||
Before sending your pull request for | ||
[review](https://github.com/google/agent_based_epidemic_sim/pulls), make sure | ||
your changes are consistent with the guidelines and follow the Agent Based | ||
Epidemic Sim coding style. | ||
|
||
#### General guidelines and philosophy for contribution | ||
|
||
* Include unit tests when you contribute new features, as they help to a) | ||
prove that your code works correctly, and b) guard against future breaking | ||
changes to lower the maintenance cost. | ||
* Bug fixes also generally require unit tests, because the presence of bugs | ||
usually indicates insufficient test coverage. | ||
* Keep API compatibility in mind when you change code in the Agent Based | ||
Epidemic Sim framework e.g., code in | ||
[agent_based_epidemic_sim/framework](https://github.com/google/agent_based_epidemic_sim/tree/master/agent_based_epidemic_sim). | ||
Once Agent Based Epidemic Sim has reached version 1 we will not make | ||
non-backward-compatible API changes without a major release. Reviewers of | ||
your pull request will comment on any API compatibility issues. | ||
* When you contribute a new feature to Agent Based Epidemic Sim, the | ||
maintenance burden is (by default) transferred to the Agent Based Epidemic | ||
Sim team. This means that benefit of the contribution must be compared | ||
against the cost of maintaining the feature. | ||
|
||
#### License | ||
|
||
Include a license at the top of new files. | ||
|
||
Bazel BUILD files also need to include a license section. | ||
|
||
#### C++ coding style | ||
|
||
Changes to Agent Based Epidemic Sim C++ code should conform to | ||
[Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html). | ||
|
||
Use `clang-tidy` to check your C/C++ changes. To install `clang-tidy` on | ||
ubuntu:16.04, do: | ||
|
||
```bash | ||
apt-get install -y clang-tidy | ||
``` | ||
|
||
You can check a C/C++ file by doing: | ||
|
||
```bash | ||
clang-format <my_cc_file> --style=google > /tmp/my_cc_file.cc | ||
diff <my_cc_file> /tmp/my_cc_file.cc | ||
``` | ||
|
||
#### Coding style for other languages | ||
|
||
* [Google Shell Style Guide](https://google.github.io/styleguide/shell.xml) |
Oops, something went wrong.