-
Notifications
You must be signed in to change notification settings - Fork 116
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create and write the CONTRIBUTING.md document outlining forward proje…
…ct additions.
- Loading branch information
1 parent
4d1d415
commit e68c5d7
Showing
1 changed file
with
43 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# Contributing to AnalyzeMFT | ||
|
||
We welcome all contributions to AnalyzeMFT and appreciate your effort in helping improve this project! | ||
|
||
Please take a moment to read through the following guidelines before opening an issue, pull request (PR), or making any contributions. | ||
|
||
## Code of Conduct | ||
|
||
1. **Issues and Pull Requests (PRs)** | ||
You are encouraged to open as many issues or PRs as you see necessary. Contributions are always welcome! | ||
|
||
2. **Commit Guidelines** | ||
To maintain a clean and manageable project history: | ||
- Each commit should represent **ONE** discrete change. Avoid bundling multiple changes into a single commit. | ||
- PRs will be **squashed** if necessary, but we strongly prefer a clear change-by-change commit history. This is essential for effective debugging and maintaining code quality. | ||
|
||
## How to Contribute | ||
|
||
### Reporting Bugs | ||
- **Create an issue** for any bug you encounter. Make sure to describe the issue clearly and include any necessary information (e.g., error messages, logs, steps to reproduce). | ||
- Feel free to contribute a fix after reporting! | ||
|
||
### Proposing New Features | ||
- **Open an issue** to discuss your proposed feature before opening a PR. It’s important to make sure it aligns with the project goals. | ||
|
||
### Making Changes | ||
1. **Fork the repository** and create your branch from `main`. | ||
2. **Make your changes**, ensuring that they address one issue at a time. | ||
3. **Test your changes** thoroughly. | ||
4. **Submit a pull request**, referencing the related issue if applicable. | ||
|
||
### Commit Messages | ||
- Use concise and descriptive commit messages that explain the context of your change. | ||
- Reference the issue number (if applicable) in your commit message. | ||
|
||
## Code Style | ||
|
||
- Ensure your code follows the coding style used in the project. | ||
- Code quality is a priority, so be sure to run any existing linting or formatting checks before submitting your PR. | ||
|
||
## Thank You | ||
|
||
Your contribution is greatly appreciated, and we look forward to reviewing your work! |