Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Rough draft
  • Loading branch information
dianzrong authored May 19, 2023
1 parent 754b854 commit 20abe2a
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# How to contribute

We would love to implement your contributions to this project! We simply ask that you observe the following guidelines.

## Code Style

This project follows the guidelines in the [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html).

We (will) also have [GitHub Actions](https://github.com/MLDSAI/OpenAdapt/actions/new) that run tests and [black](https://github.com/psf/black) on each pull request to ensure consistent behaviour and style.


## Submitting Changes

1. Fork the current repository
2. Make a branch to work on, or use the main branch
3. Push desired changes onto the branch in step 2
4. Submit a pull request with the branch in step 2 as the head ref and the MLDSAI/OpenAdapt main as the base ref
- Note: may need to click "compare across forks"
5. Update pull request using feedback
- this step may not be necessary, or may need to be repeated
6. Celebrate contributioning to OpenAdapt!

0 comments on commit 20abe2a

Please sign in to comment.