Spaces:
Paused
Paused
File size: 1,496 Bytes
9f00a05 |
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 |
# Contributing Guidelines
Thank you for your interest in contributing to this repository! To ensure a smooth collaboration, please review the following guidelines:
## Pull Request Process
1. **Compatibility:**
- Ensure your changes work seamlessly on both mobile and desktop platforms.
2. **Version Bumping:**
- Update the version in relevant files (e.g., `index.js?v=number`) to the next consecutive number when modifying any files.
3. **Code Formatting:**
- Before finalizing changes, run the following command in the terminal for consistent code formatting:
```bash
npm run format
```
4. **Minifying JSON**
- Before finalizing your changes visit https://codebeautify.org/jsonminifier and compress your json and put it in the `.min.json` file. (Ex. If you are editing `a.json` you would put the minified code in `a.min.json`
5. **Test Your Changes:**
- Conduct thorough testing to ensure modifications don't introduce issues or break existing functionalities.
6. **Descriptive Pull Requests:**
- Provide clear, concise descriptions for your pull requests. Include details on the problem addressed and how your changes resolve it.
7. **Responsive Design:**
- Confirm that changes adhere to responsive design principles, ensuring a seamless user experience across various devices.
8. **Collaboration:**
- Be open to feedback and responsive to comments during the review process.
We appreciate your efforts in contributing to this project!
|