Skip to content

Commit a4dc3dd

Browse files
authored
Add documentation about how to contribute to kagglehub (#223)
http:/b//394094922
1 parent 9a38bde commit a4dc3dd

File tree

4 files changed

+35
-73
lines changed

4 files changed

+35
-73
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Changelog
22

3+
## Next Release
4+
5+
*
6+
37
## v0.3.7 (January 31, 2025)
48

59
* Add data loaders to user agent when downloading ([#215](https://github.com/Kaggle/kagglehub/pull/215))

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Contributing to kagglehub
2+
3+
First off, thanks for taking the time to contribute!
4+
5+
All types of contributions are encouraged and valued.
6+
7+
## Issues
8+
9+
We use GitHub issues to track **public** bugs and feature requests. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
10+
11+
If you found a bug or have a feature request, follow these instructions:
12+
13+
* Open an [Issue](/issues/new).
14+
* Provide as much context as you can about what you're running into.
15+
* Provide project and platform versions (python, pip, kagglehub), depending on what seems relevant.
16+
17+
## Pull Requests (PRs)
18+
19+
We encourage everyone to open an issue first to discuss the general approach before opening a PR to reduce churns. If your solution to a bug you found is trivial, we also accept PRs directly.
20+
21+
Please follow these best practices when opening a PR:
22+
23+
* Use a **clear and descriptive title**.
24+
* If your PR adds a user-facing feature or fixes a bug, make sure to add an entry under the "Next Release" section in the [CHANGELOG.md](CHANGELOG.md)
25+
* If your PR fixes a specific issue, add `Fixes #<ISSUE_NUMBER>` to your PR's description.
26+
* Include screenshots/console output of the behavior before and after the fix.
27+
* Include instructions on how to reproduce the issue and test the fixes.

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -437,3 +437,7 @@ The table below contains possible locations:
437437
If needed, the root log directory can be overriden using the following environment variable: `KAGGLE_LOGGING_ROOT_DIR`
438438

439439
Please include the log to help troubleshoot issues.
440+
441+
## Contributing
442+
443+
If you'd like to contribute to `kagglehub`, please make sure to take a look at [CONTRIBUTING.md](CONTRIBUTING.md).

tools/release/prepare-release.sh

Lines changed: 0 additions & 73 deletions
This file was deleted.

0 commit comments

Comments
 (0)