Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added CONTRIBUTING.md file #172

Merged
merged 4 commits into from
Jul 6, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Contributing to Causal Pyro

## Development

Please follow our established coding style including variable names, module imports, and function definitions. The Causal Pyro codebase follows the [PEP8 style guide](https://www.python.org/dev/peps/pep-0008/) (which you can check with `make lint`) and follows [`isort`](https://github.com/timothycrosley/isort) import order (which you can enforce with `make format`).

## Dev Setup
To install dev dependencies for Causal Pyro, run the following command.
```sh
pip install -e .[test]
```

## Testing

Before submitting a pull request, please autoformat code and ensure that unit tests pass locally
```sh
make lint # linting
make format # runs black and isort
make tests # linting and unit tests
```

## Submitting

For relevant design questions to consider, see past [design documents](https://github.com/pyro-ppl/pyro/wiki/Design-Docs).

For larger changes, please open an issue for discussion before submitting a pull request.

In your PR, please include:
- Changes made
- Links to related issues/PRs
- Tests
- Dependencies

For speculative changes meant for early-stage review, include `[WIP]` in the PR's title. (One of the maintainers will add the `WIP` tag.)

## Code of conduct
This project follows [GitHub community guidelines](https://help.github.com/en/github/site-policy/github-community-guidelines) and [Pyro code of conduct](https://github.com/pyro-ppl/pyro/blob/dev/CODE_OF_CONDUCT.md).
11 changes: 11 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
lint: FORCE
scripts/lint.sh

format:
black .
isort .
agrawalraj marked this conversation as resolved.
Show resolved Hide resolved

tests: lint FORCE
pytest -v tests

FORCE: