|
1 |
| -# Contributors |
| 1 | +# Contributoring |
| 2 | + |
| 3 | +## How to Contribute |
| 4 | + |
| 5 | +All types of contributions are welcome, including but not limited to: |
| 6 | +- Code improvements |
| 7 | +- Documentation updates |
| 8 | +- Bug reports |
| 9 | +- Feature suggestions |
| 10 | +- User experience feedback |
| 11 | + |
| 12 | +### Development Setup |
| 13 | + |
| 14 | +1. Fork the repository |
| 15 | +2. Clone your fork: |
| 16 | +```bash |
| 17 | +git clone https://github.com/your-username/lsq.git |
| 18 | +``` |
| 19 | +3. Add the upstream remote: |
| 20 | +```bash |
| 21 | +git remote add upstream https://github.com/jrswab/lsq.git |
| 22 | +``` |
| 23 | +4. Create a branch for your work: |
| 24 | +```bash |
| 25 | +git checkout -b your-feature-branch |
| 26 | +``` |
| 27 | + |
| 28 | +### Pull Request Process |
| 29 | + |
| 30 | +1. One feature or bug fix per PR. |
| 31 | +2. Update the README.md with details of any interface changes if applicable |
| 32 | +3. Update CHANGELOG.md to include your changes under the `Unreleased` section. |
| 33 | +4. Use clear, descriptive commit messages |
| 34 | +5. Make sure your branch is up to date with main before submitting |
| 35 | +6. Include a clear description of the changes in your PR |
| 36 | + |
| 37 | +### First Time Contributors |
| 38 | + |
| 39 | +New to contributing? Look for issues tagged with `good-first-issue` or `documentation`. These are great starting points! |
2 | 40 |
|
3 | 41 | Thank you to all the people who have contributed to lsq! ❤️
|
4 | 42 |
|
5 | 43 | ## Core Contributors
|
6 | 44 |
|
7 | 45 | - [jrswab](https://github.com/jrswab) - Creator and maintainer
|
8 | 46 |
|
9 |
| -## Early Contributors |
| 47 | +## Contributors |
| 48 | +*Note: This file is manually updated with new contributors. If you've contributed and don't see your name, please let me know!* |
10 | 49 |
|
11 | 50 | - [kandros](https://github.com/kandros) - Documentation improvements
|
12 | 51 | - First pull request! 🎉
|
13 | 52 | - Fixed README.md external links
|
14 |
| - |
15 |
| -## How to Contribute |
16 |
| - |
17 |
| -We welcome all types of contributions, including but not limited to: |
18 |
| -- Code improvements |
19 |
| -- Documentation updates |
20 |
| -- Bug reports |
21 |
| -- Feature suggestions |
22 |
| -- User experience feedback |
23 |
| - |
24 |
| -See the [README.md](README.md) for more information on getting started with contributing. |
25 |
| - |
26 |
| ---- |
27 |
| -*Note: This file is manually updated with new contributors. If you've contributed and don't see your name, please let me know!* |
|
0 commit comments