Skip to content

Commit 2cb0bcf

Browse files
authored
Create CONTRIBUTING.md
1 parent 74f2793 commit 2cb0bcf

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

CONTRIBUTING.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Contributing Guidelines
2+
3+
Thank you for your interest in **coredocs-netbox-scripts**.
4+
5+
## Reporting Issues
6+
- First, check the [issue tracker](../../issues) to avoid duplicates.
7+
- Use the provided templates when opening a new issue (Bug or Feature).
8+
- For bugs, please include:
9+
- Expected vs. actual behavior
10+
- Steps to reproduce
11+
- NetBox version
12+
- Relevant logs or error messages
13+
14+
## Pull Requests
15+
- Fork the repository and base your work on the `main` branch.
16+
- Create a branch in your fork for your changes (e.g. `my-fix` or `my-feature`).
17+
- Keep pull requests small and focused.
18+
- Clearly describe what changed, why it changed, and which NetBox versions you tested against.
19+
- Make sure all checks pass before submitting.
20+
21+
## Compatibility
22+
- Target compatibility with **NetBox** (please state which version you tested against).
23+
- Do not introduce hidden dependencies.
24+
25+
## Tests & Examples
26+
- If possible, provide a minimal example or test case to demonstrate the change or new feature.
27+
28+
## Commit Messages
29+
- Use clear commit messages, prefixed when appropriate:
30+
- `fix:` for bug fixes
31+
- `feat:` for new features
32+
- `docs:` for documentation changes
33+
- `refactor:` for code restructuring
34+
- `chore:` for maintenance tasks
35+
36+
## Code of Conduct
37+
This project follows the [Code of Conduct](./CODE_OF_CONDUCT.md).
38+
Violations can be reported via [GitHub Issues](../../issues).

0 commit comments

Comments
 (0)