Skip to content

Latest commit

 

History

History
41 lines (23 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

41 lines (23 loc) · 1.46 KB
Raw

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: 
      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!