-
-
Notifications
You must be signed in to change notification settings - Fork 150
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rough draft
- Loading branch information
Showing
1 changed file
with
21 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,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! |