Skip to content

Commit 2ae8663

Browse files
authored
Merge pull request #23 from atellaluca/feature/spy-on-arch
Enhancing ImportSpy with Comprehensive Validation, Security, and Documentation Improvements
2 parents 10a7657 + 76a898f commit 2ae8663

File tree

86 files changed

+7757
-1474
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+7757
-1474
lines changed

CONTRIBUTING.md

+24-41
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,33 @@
11
# Contributing to ImportSpy
22

3-
We welcome contributions! If you'd like to help improve ImportSpy, please follow these guidelines:
3+
🎉 Thank you for considering a contribution to **ImportSpy**! We value your efforts and welcome **issues, features, and documentation improvements**.
44

5-
## Issues and Bug Reports
5+
## 📢 How to Contribute
66

7-
- Before submitting an issue, check the [issue tracker](https://github.com/atellaluca/ImportSpy/issues) to see if someone else has already reported the same problem.
8-
- If it's a new issue, provide a clear and detailed description of the problem.
9-
- Include steps to reproduce the bug, if applicable.
7+
### 🔍 1. Issue Reporting
8+
If you find a **bug** or have a **feature request**, please open an issue:
9+
🔗 [GitHub Issues](https://github.com/atellaluca/ImportSpy/issues)
1010

11-
## Feature Requests
11+
### 🔄 2. Fork & Branching Strategy
12+
- **Create a fork** and work on a separate branch before submitting a pull request.
13+
- Use the following **branch naming conventions**:
14+
- **For features:** `feature/nome-feature-in-breve`
15+
- **For bug fixes:** `fix/bugfix-description`
16+
- **For documentation:** `docs/update-section`
1217

13-
- We welcome suggestions for new features! You can open a feature request by creating a new issue and labeling it with `enhancement`.
14-
- Clearly explain the feature you'd like to see, why it would be useful, and any potential implementation ideas.
18+
### ✅ 3. Code Style & Commit Rules
19+
- **Follow Conventional Commits**:
20+
- `feat:` → For new features
21+
- `fix:` → For bug fixes
22+
- `docs:` → For documentation changes
23+
- `test:` → For tests
24+
- `refactor:` → Code improvements without changing functionality
1525

16-
## Pull Requests
26+
Example:
27+
```bash
28+
git commit -m "feat: add validation for OS compatibility"
29+
```
1730

18-
To contribute code, please follow these steps:
31+
💡 **We Appreciate Every Contribution!**
1932

20-
1. **Fork the repository**: Create your own copy of the project.
21-
2. **Clone the repository**:
22-
```bash
23-
git clone https://github.com/your-username/ImportSpy.git
24-
```
25-
3. **Create a new branch** for your feature or bugfix:
26-
```bash
27-
git checkout -b feature-name
28-
```
29-
4. **Make your changes**: Ensure your code adheres to the coding style of the project and is well-documented.
30-
5. **Test your changes**: Run tests to make sure your modifications work as expected.
31-
6. **Commit your changes**:
32-
```bash
33-
git commit -m "Brief description of changes"
34-
```
35-
7. **Push to your branch**:
36-
```bash
37-
git push origin feature-name
38-
```
39-
8. **Submit a Pull Request**: Go to the repository on GitHub and open a pull request. Clearly describe the changes and link to any related issues.
40-
41-
## Code Style and Standards
42-
43-
- Please ensure your code follows the project’s style guide. We prefer consistent naming conventions and readable code.
44-
- If you're submitting a large change, consider discussing it in an issue first.
45-
46-
## Questions
47-
48-
If you have any questions, feel free to open an issue or contact us directly.
49-
50-
Thank you for contributing!
33+
ImportSpy is an open-source project, and every contribution—big or small—helps make it better. 🚀

0 commit comments

Comments
 (0)