Skip to content
This repository was archived by the owner on Apr 29, 2025. It is now read-only.

Commit 58fd922

Browse files
authored
docs: add development guidelines (#73)
2 parents 58d79d6 + 22fc56c commit 58fd922

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,3 +51,27 @@ This project aims to provide tools and methodologies for identifying and address
5151
```
5252

5353
9. Run the analysis
54+
55+
## Development Guidelines
56+
57+
### Branching Strategy
58+
59+
- **For Tool development**: branch from and merge into the `tool` branch
60+
- **For Plugin development**: branch from and merge into the `plugin` branch
61+
- Use descriptive branch names, e.g., `feature/fehmi-tool-new-detector` or `bugfix/name-plugin-ui-crash`
62+
63+
### Commit Messages
64+
65+
Follow the [Conventional Commits](https://www.conventionalcommits.org/) specification to aid in automatic changelog generation and versioning.
66+
67+
### Pull Requests
68+
69+
1. Create a Pull Request (PR) when your feature or fix is ready for review
70+
2. Ensure all tests pass and code meets the project's quality standards
71+
3. Request reviews from team members
72+
73+
### CI/CD Pipeline
74+
75+
GitHub Actions will automatically run on your PR, checking build status, tests, and generating coverage reports. Review the CI/CD output in your PR before merging.
76+
77+

0 commit comments

Comments
 (0)