|
1 | | -# Contributing to Web3 Skills Tracker |
2 | 1 |
|
3 | | -Thank you for your interest in contributing to the Web3 Skills Tracker project. This document provides guidelines and instructions for contributing. |
| 2 | +## 🤝 Contributing |
4 | 3 |
|
5 | | -## How to Contribute |
| 4 | +We welcome contributions from the community! Here's how you can help: |
6 | 5 |
|
7 | | -### Reporting Bugs |
| 6 | +### **Ways to Contribute** |
| 7 | +1. **Add New Skills** - Suggest skills we're missing |
| 8 | +2. **Update Resources** - Share better learning materials |
| 9 | +3. **Add Career Paths** - Suggest new Web3 careers |
| 10 | +4. **Fix Bugs** - Report or fix issues |
| 11 | +5. **Improve UI** - Enhance the design |
| 12 | +6. **Translate** - Help translate to other languages |
8 | 13 |
|
9 | | -If you find a bug, please create an issue with the following information: |
| 14 | +### **Contribution Process** |
| 15 | +```bash |
| 16 | +# Fork the repository |
| 17 | +# Create your feature branch |
| 18 | +git checkout -b feature/amazing-feature |
10 | 19 |
|
11 | | -1. Clear, descriptive title |
12 | | -2. Steps to reproduce the issue |
13 | | -3. Expected behavior |
14 | | -4. Actual behavior |
15 | | -5. Screenshots (if applicable) |
16 | | -6. Browser and OS information |
| 20 | +# Commit your changes |
| 21 | +git commit -m 'Add some amazing feature' |
17 | 22 |
|
18 | | -### Suggesting Features |
| 23 | +# Push to the branch |
| 24 | +git push origin feature/amazing-feature |
19 | 25 |
|
20 | | -We welcome feature suggestions! Please create an issue with: |
21 | | - |
22 | | -1. Clear description of the feature |
23 | | -2. Use cases and benefits |
24 | | -3. Potential implementation approach |
25 | | -4. Any relevant examples or mockups |
26 | | - |
27 | | -### Adding Skills or Career Paths |
28 | | - |
29 | | -To add new skills or career paths: |
30 | | - |
31 | | -1. Fork the repository |
32 | | -2. Create a new branch: `git checkout -b feature/add-new-career-path` |
33 | | -3. Update the relevant data structures in `src/App.js` |
34 | | -4. Test your changes locally |
35 | | -5. Commit your changes with a clear message |
36 | | -6. Push to your fork and submit a pull request |
37 | | - |
38 | | -#### Adding Skills |
39 | | - |
40 | | -Add new skills to the `initialSkills` object and appropriate category: |
41 | | - |
42 | | -```javascript |
43 | | -// In initialSkills |
44 | | -'New Skill Name': false, |
45 | | - |
46 | | -// In categories |
47 | | -'Category Name': [...existingSkills, 'New Skill Name'], |
| 26 | +# Open a Pull Request |
48 | 27 | ``` |
49 | 28 |
|
50 | | -#### Adding Career Paths |
51 | | - |
52 | | -Add a new career path to the `careerPaths` object: |
53 | | - |
54 | | -```javascript |
55 | | -'Career Path Name': { |
56 | | - description: 'Brief description of the role', |
57 | | - requiredSkills: [ |
58 | | - 'Skill 1', |
59 | | - 'Skill 2', |
60 | | - // List 8-12 key skills |
61 | | - ], |
62 | | - roadmap: [ |
63 | | - { |
64 | | - phase: 'Foundation', |
65 | | - skills: ['Skill 1', 'Skill 2'], |
66 | | - duration: '2-3 months' |
67 | | - }, |
68 | | - // Add 3-5 phases |
69 | | - ], |
70 | | - resources: [ |
71 | | - 'Resource 1', |
72 | | - 'Resource 2', |
73 | | - // Add 4-6 learning resources |
74 | | - ] |
75 | | -} |
76 | | -``` |
77 | | - |
78 | | -### Code Style Guidelines |
79 | | - |
80 | | -- Use functional React components |
81 | | -- Follow existing code formatting |
82 | | -- Use meaningful variable and function names |
83 | | -- Add comments for complex logic |
84 | | -- Keep functions small and focused |
85 | | -- Use Tailwind CSS classes for styling |
86 | | - |
87 | | -### Pull Request Process |
88 | | - |
89 | | -1. Update the README.md with details of changes if applicable |
90 | | -2. Ensure your code follows the existing style |
91 | | -3. Test thoroughly on multiple browsers |
92 | | -4. Update documentation as needed |
93 | | -5. Reference any related issues in your PR description |
94 | | - |
95 | | -### Pull Request Checklist |
96 | | - |
97 | | -- [ ] Code follows the project style guidelines |
98 | | -- [ ] All tests pass locally |
99 | | -- [ ] Documentation has been updated |
100 | | -- [ ] Commit messages are clear and descriptive |
101 | | -- [ ] No console errors or warnings |
102 | | -- [ ] Tested on Chrome, Firefox, and Safari |
103 | | -- [ ] Mobile responsive design maintained |
104 | | - |
105 | | -## Development Setup |
106 | | - |
107 | | -See [SETUP.md](SETUP.md) for detailed setup instructions. |
108 | | - |
109 | | -## Testing Guidelines |
110 | | - |
111 | | -Before submitting a PR: |
112 | | - |
113 | | -1. Test all interactive features |
114 | | -2. Verify localStorage persistence |
115 | | -3. Test import/export functionality |
116 | | -4. Check responsive design on mobile |
117 | | -5. Test in multiple browsers |
118 | | -6. Verify no console errors |
119 | | - |
120 | | -## Code Review Process |
121 | | - |
122 | | -1. A maintainer will review your PR |
123 | | -2. They may request changes or ask questions |
124 | | -3. Make requested changes and push to your branch |
125 | | -4. Once approved, your PR will be merged |
126 | | - |
127 | | -## Community Guidelines |
128 | | - |
129 | | -- Be respectful and constructive |
130 | | -- Welcome newcomers |
131 | | -- Help others when possible |
132 | | -- Follow the code of conduct |
133 | | -- Give credit where credit is due |
134 | | - |
135 | | -## Questions? |
136 | | - |
137 | | -If you have questions about contributing, feel free to: |
138 | | - |
139 | | -- Open an issue with the "question" label |
140 | | -- Reach out to the maintainers |
141 | | -- Check existing issues and PRs |
142 | | - |
143 | | -## Recognition |
144 | | - |
145 | | -Contributors will be recognized in: |
146 | | -- The project README |
147 | | -- Release notes |
148 | | -- GitHub contributors page |
149 | | - |
150 | | -Thank you for helping make Web3 Skills Tracker better! |
| 29 | +### **Guidelines** |
| 30 | +- Follow the existing code style |
| 31 | +- Test your changes thoroughly |
| 32 | +- Update documentation if needed |
| 33 | +- Keep commits clear and descriptive |
0 commit comments