Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
8 changes: 6 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)
<!-- Depending on whether the PR fixes the Issue fully or partially -->

Fixes # (issue) <!-- The issue is fixed in whole (no futher work will be needed) -->

Partial issue # (issue) <!-- In-case the issue is partially fixed, i.e., still some work may be needed -->

## Type of change

Expand All @@ -25,4 +29,4 @@ Please describe the tests that you ran to verify your changes. Provide instructi
## Checklist:

- [ ] New Unit tests added
- [ ] Unit tests pass locally with my changes
- [ ] Unit tests pass locally with my changes
18 changes: 9 additions & 9 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Install wheel:
$ pip install dist/pydp-0.1.0-py2.py3-none-any.whl
```

### Docker Support
## Docker Support

Dockerfile is added so users on all systems can get involved in development. Windows developers can start contrbiuting with the help of Docker support.

Expand Down Expand Up @@ -92,18 +92,18 @@ Note: After each change in your code, you have to run:
$ docker build -t pydp:test .
```

## Pre-requisites

Nothing in particular, prereqs takes care of everything.

## Project Structure

_To be updated_

### Third Party dependencies

Make sure you run:

```
$ ./ext_source_setup.sh
```

## Coding Standards

For Naming of modules, classes and methods in Python, make sure you follow naming conventions found [here](https://visualgit.readthedocs.io/en/latest/pages/naming_convention.html).

For C++ Styling, we follow Google's coding standard. Read more about it [here](./.clang-format).

For Python Formatting, we use [Black](https://black.readthedocs.io/en/stable/the_black_code_style.html), a stricter subset of PEP8.
2 changes: 1 addition & 1 deletion examples/1.1 - Introductions to PyDP.ipynb

Large diffs are not rendered by default.