Skip to content

Commit 15768bd

Browse files
committed
📝 add contributing guide (issue #83)
1 parent 9dc0c49 commit 15768bd

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Contributing to bde
2+
3+
Thanks for your interest in improving `bde`. We welcome bug reports,
4+
documentation fixes, examples, tests, and focused code contributions.
5+
6+
Please use GitHub as the default place for project communication:
7+
8+
- Issues: https://github.com/scikit-learn-contrib/bde/issues
9+
- Pull requests: https://github.com/scikit-learn-contrib/bde/pulls
10+
11+
## Contributing changes
12+
13+
For small fixes, open a pull request directly. For larger changes or API changes,
14+
please open an issue first so the approach can be discussed.
15+
16+
Recommended workflow:
17+
18+
1. Fork the repository.
19+
2. Create a branch for your change.
20+
3. Install the development environment as outlined in the README and do not forget to also install the `pre-commit` hooks.
21+
4. Add tests or documentation when relevant.
22+
5. Run the relevant checks (lint,tests).
23+
6. Open a pull request on GitHub and link any related issue.
24+
25+
## Reporting issues
26+
27+
Please report bugs, feature requests, and documentation problems through GitHub
28+
Issues. Before opening a new issue, check whether a similar issue already exists.
29+
30+
For bug reports, include:
31+
32+
- A minimal reproducible example.
33+
- The full traceback or error message.
34+
- Your operating system, Python version, and relevant package versions.
35+
- The expected behavior and the behavior you observed.
36+
37+
## Seeking support
38+
39+
Please use GitHub Issues for usage questions and support requests. This keeps
40+
answers visible to other users and helps the project maintain a searchable record.
41+
42+
Direct email to the maintainers should be reserved for rare cases that are not
43+
appropriate for a public GitHub issue, such as sensitive or private matters.

0 commit comments

Comments
 (0)