Skip to content

Commit acfb02a

Browse files
committed
🦸 Update CONTRIBUTING.md with "Submitting a Pull Request (PR)" instructions
1 parent 9f47c3a commit acfb02a

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

CONTRIBUTING.md

+17-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,21 @@
11
## 🦸 Contributing to Roboflow Notebooks
22

3-
We love your input! We want to make contributing to Roboflow Notebooks as easy and transparent as possible.
3+
We love your input! We want to make contributing to Roboflow Notebooks as easy and transparent as possible, whether it's:
44

5-
- 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.
6-
- When adding or editing notebooks, make sure to specify the versions of pip packages 📦 you are using.
5+
- Reporting a bug
6+
- Discussing the current state of the code
7+
- Submitting a fix
8+
- Proposing a new feature
9+
- Becoming a maintainer
710

8-
Please keep in mind that repository is still under construction 🚧. We will add more contribution guidelines soon.
11+
## 🛠️ Submitting a Pull Request (PR)
12+
13+
- Add new notebook `.ipynb` file to `notebooks` directory.
14+
- Add new entry to `automation/notebooks-table-data.csv` file.
15+
- Run `automation/autogenerate_notebooks_table.py` script. Roboflow Notebooks table in `README.md` will update
16+
automatically.
17+
- Commit changes to feature branch. Create PR.
18+
19+
## © License
20+
21+
By contributing, you agree that your contributions will be licensed under the [MIT](https://github.com/roboflow/supervision/blob/main/LICENSE.md) license.

0 commit comments

Comments
 (0)