mirrors/Detect-It-Easy
2
0
Fork 0
mirror of https://github.com/horsicq/Detect-It-Easy.git synced 2026-06-24 01:54:08 +00:00
Code Issues Projects Releases Packages Wiki Activity

add CONTRIBUTING.md

Browse source 
This markdown file introduces our contribution guidelines for Detect It Easy
This commit is contained in:
Benjamin Funke 2025-11-14 22:25:17 +01:00
commit 0909d8c043
1 changed files with 45 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

45
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,45 @@
# Contributing to Detect-It-Easy
Welcome in contributing to Detect-It-Easy!
## Ask Questions
Curiosity is key to driving the project forward. If you have questions or ideas for improvement, don't hesitate to reach out. You can start a discussion by [opening a new issue](https://github.com/horsicq/Detect-It-Easy/issues/new).
## How to Report Issues
To report bugs and errors, please [open a new issue](https://github.com/horsicq/Detect-It-Easy/issues/new) on GitHub. Include detailed steps to reproduce the bug, along with any relevant stack traces, error messages, or affected files.
## Feature Requests
If you have ideas for new features or enhancements, feel free to [open a new issue](https://github.com/horsicq/Detect-It-Easy/issues/new) to discuss them. Your input is valuable in shaping the future of the project.
## Coding Standards and Formatting Rules
To maintain code quality and consistency across the project, please adhere to the following guidelines when contributing code:
- **Language and Style**: The project primarily uses DiE-JS. Follow the existing code style.
- **Formatting**: Use consistent indentation (4 spaces, no tabs).
- **Commits**: Write descriptive commit messages. Use the imperative mood (e.g., "Fix bug in file parser" instead of "Fixed bug").
- **Testing**: Include unit tests for new features or bug fixes where applicable. Ensure they are compilable!
## Guidelines for Translations or Code Contributions
We welcome contributions to translations and code to make Detect-It-Easy accessible to a global audience:
- **Translations**: If you'd like to add or update translations, fork the XTranslation repository and work on the relevant language files (typically in the `dicts/` directory). Ensure translations are accurate and culturally appropriate. Test them in the application to verify context. Use poedit for translating languages!
- **Process**: Submit changes via a pull request (see below).
- **Quality**: Proofread your contributions for grammar and clarity. Maintain consistency with the existing tone and style.
## How to Submit Pull Requests
1. Fork the repository on GitHub.
2. Create a new branch for your changes (e.g., `feature/new-detection-rule` or `fix/bug-123`).
3. Make your changes, ensuring they follow the coding standards and guidelines above.
4. Test your changes thoroughly.
5. Commit your changes with a clear, descriptive message.
6. Push your branch to your fork and [open a pull request](https://github.com/horsicq/Detect-It-Easy/compare) against the main branch.
7. In the pull request description, explain what changes you made and why. Reference any related issues.
8. Be responsive to feedback from maintainers and make requested revisions.
Pull requests will be reviewed, and once approved, merged into the project. Thank you for helping improve Detect-It-Easy!