|
1 | 1 | ## Contributing to Spectrum UI
|
2 | 2 |
|
3 |
| -Thank you for your interest in contributing to Spectrum UI! We value contributions from the community to help improve and expand the library. Whether it's a bug fix, a new feature, or an enhancement, your input is appreciated! |
| 3 | +Thank you for your interest in contributing to Spectrum UI! 🎉 |
| 4 | +We value contributions from the community, whether it's a bug fix, a new feature, or an enhancement. Your input helps us grow and improve the library. |
| 5 | + |
| 6 | +--- |
4 | 7 |
|
5 | 8 | ### How to Contribute
|
6 | 9 |
|
7 |
| -Follow these steps to contribute to Spectrum UI: |
| 10 | +Follow these steps to get started with contributing to Spectrum UI: |
| 11 | + |
| 12 | +--- |
| 13 | + |
| 14 | +#### 1. **Fork the Repository** |
| 15 | +Click the "Fork" button at the top-right of the repository page to create your own copy of the project. |
| 16 | + |
| 17 | +--- |
| 18 | + |
| 19 | +#### 2. **Clone Your Fork** |
| 20 | +Clone your forked repository to your local machine: |
| 21 | + |
| 22 | +```bash |
| 23 | +git clone https://github.com/arihantcodes/spectrum-ui.git |
| 24 | +cd spectrum-ui |
| 25 | +``` |
| 26 | + |
| 27 | +--- |
| 28 | + |
| 29 | +#### 3. **Install Dependencies** |
| 30 | +Run the following command to install the project's dependencies: |
| 31 | + |
| 32 | +```bash |
| 33 | +npm install |
| 34 | +``` |
| 35 | + |
| 36 | +--- |
| 37 | + |
| 38 | +#### 4. **Start the Development Server** |
| 39 | +Run the development server to test your changes locally: |
| 40 | + |
| 41 | +```bash |
| 42 | +npm run dev |
| 43 | +``` |
| 44 | + |
| 45 | +--- |
| 46 | + |
| 47 | +#### 5. **Create a New Branch** |
| 48 | +Create a branch for your feature or fix: |
| 49 | + |
| 50 | +```bash |
| 51 | +git checkout -b feature-name |
| 52 | +``` |
| 53 | + |
| 54 | +--- |
| 55 | + |
| 56 | +#### 6. **Make Your Changes** |
| 57 | +Edit the code to implement your feature or fix the bug. |
| 58 | + |
| 59 | +--- |
| 60 | + |
| 61 | +#### 7. **Commit Your Changes** |
| 62 | +After making your changes, commit them with a descriptive message: |
| 63 | + |
| 64 | +```bash |
| 65 | +git commit -m "Add feature-name" |
| 66 | +``` |
| 67 | + |
| 68 | +--- |
| 69 | + |
| 70 | +#### 8. **Push Your Changes** |
| 71 | +Push your branch to your forked repository: |
| 72 | + |
| 73 | +```bash |
| 74 | +git push origin feature-name |
| 75 | +``` |
| 76 | + |
| 77 | +--- |
| 78 | + |
| 79 | +#### 9. **Create a Pull Request (PR)** |
| 80 | +- Go to the [Pull Requests](https://github.com/your-username/spectrum-ui/pulls) section of the original repository. |
| 81 | +- Click **"New Pull Request"**. |
| 82 | +- Select your branch and submit your PR. |
| 83 | +- Provide a clear description of your changes, including why they are beneficial. |
| 84 | + |
| 85 | +--- |
| 86 | + |
| 87 | +### Contribution Guidelines |
| 88 | + |
| 89 | +- Ensure your code adheres to the project's coding standards and best practices. |
| 90 | +- Write descriptive commit messages for easy tracking. |
| 91 | +- Test your changes thoroughly to avoid introducing bugs. |
| 92 | + |
| 93 | +--- |
| 94 | + |
| 95 | +### Contributors |
8 | 96 |
|
9 |
| -1. **Fork the repository** |
10 |
| - Click the "Fork" button at the top of the repository page to create your own copy of the project. |
| 97 | +Thanks to all the amazing contributors who have helped improve Spectrum UI! 💖 |
11 | 98 |
|
12 |
| -2. **Clone your fork** |
13 |
| - Clone the repository to your local machine: |
| 99 | +<div align="center"> |
14 | 100 |
|
15 |
| - ``` |
16 |
| - git clone https://github.com/your-username/spectrum-ui.git |
| 101 | + |
17 | 102 |
|
18 |
| - ``` |
19 |
| - ``` |
20 |
| - npm install |
21 |
| - ``` |
22 |
| - ``` |
23 |
| - npm run dev |
24 |
| - ``` |
25 |
| - git checkout -b feature-name |
| 103 | +</div> |
26 | 104 |
|
27 |
| - ``` |
28 |
| - git commit -m 'Add feature-name' |
29 |
| - ``` |
30 |
| - git push origin feature-name |
| 105 | +#### List of Contributors: |
31 | 106 |
|
32 |
| - Create a Pull Request |
33 |
| -Go to the repository’s pull request section and submit a PR. Make sure to describe the changes you made and why they are beneficial. |
| 107 | +1. [arihantcodes](https://github.com/arihantcodes) |
| 108 | +2. [itzamanjain](https://github.com/itzamanjain) |
| 109 | +3. [Harsha-10](https://github.com/Harsha-10) |
| 110 | +4. [Prince5723](https://github.com/Prince5723) |
| 111 | +5. [Pratiyankkumar](https://github.com/Pratiyankkumar) |
| 112 | +6. [veerendra19codes](https://github.com/veerendra19codes) |
| 113 | +7. [0xKafkaa](https://github.com/0xKafkaa) |
| 114 | +8. [AayushVinayDev](https://github.com/AayushVinayDev) |
34 | 115 |
|
| 116 | +Want to see your name here? Follow the steps above and contribute today! 🚀 |
0 commit comments