github-security-alerts/CONTRIBUTING at main · pylapp/github-security-alerts · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# Contributing

Thanks for your interest in contributing 🙌

---

## 🚀 How to Contribute

1. Fork the repository
2. Create a feature branch from `main`

git checkout -b feature/my-feature

3. Make your changes
4. Commit your work

git commit -m "feat: add new feature"

5. Push your branch

git push origin feature/my-feature

6. Open a Pull Request

---

## ✅ Guidelines

- Keep code simple and readable
- Follow existing project structure
- Reuse existing patterns when possible
- Avoid unnecessary dependencies

---

## 🧪 Before Submitting

- App builds successfully
- No obvious regressions
- Tests pass (if applicable)

---

## 🐛 Issues

Feel free to open an issue for:

- Bugs
- Feature requests
- Questions

---

## 💡 Tips

- Prefer small, focused Pull Requests
- Add context in your PR description
- Screenshots are welcome for UI changes

---

## 📜 Commit Convention (optional but recommended)

Examples:

- feat: add new feature
- fix: resolve issue with login
- chore: update dependencies
- docs: improve README

---

Thanks again for contributing 🚀