forked from roboflow/notebooks
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
🦸 Update
CONTRIBUTING.md
with "Submitting a Pull Request (PR)" inst…
…ructions
- Loading branch information
Showing
1 changed file
with
17 additions
and
4 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 |
---|---|---|
@@ -1,8 +1,21 @@ | ||
## 🦸 Contributing to Roboflow Notebooks | ||
|
||
We love your input! We want to make contributing to Roboflow Notebooks as easy and transparent as possible. | ||
We love your input! We want to make contributing to Roboflow Notebooks as easy and transparent as possible, whether it's: | ||
|
||
- When creating new notebook, make sure to use our [template](https://github.com/roboflow-ai/notebooks/blob/main/notebooks/_train-template.ipynb) as starting point. It contains all the elements that we would like to include in our notebooks from now on. | ||
- When adding or editing notebooks, make sure to specify the versions of pip packages 📦 you are using. | ||
- Reporting a bug | ||
- Discussing the current state of the code | ||
- Submitting a fix | ||
- Proposing a new feature | ||
- Becoming a maintainer | ||
|
||
Please keep in mind that repository is still under construction 🚧. We will add more contribution guidelines soon. | ||
## 🛠️ Submitting a Pull Request (PR) | ||
|
||
- Add new notebook `.ipynb` file to `notebooks` directory. | ||
- Add new entry to `automation/notebooks-table-data.csv` file. | ||
- Run `automation/autogenerate_notebooks_table.py` script. Roboflow Notebooks table in `README.md` will update | ||
automatically. | ||
- Commit changes to feature branch. Create PR. | ||
|
||
## © License | ||
|
||
By contributing, you agree that your contributions will be licensed under the [MIT](https://github.com/roboflow/supervision/blob/main/LICENSE.md) license. |