The following guidelines should be followed to contribute to our project:

  1. Fork the repository - Fork the repository on GitHub and clone it to your local machine.

  2. Create a new branch - Create a new branch to work on a specific feature or bug fix.

    References for best practices in naming branches: https://climbtheladder.com/8-git-branch-naming-best-practices/

    For naming the branch, use this format:

    feat-issue/<design-page-name>

    example: feat-8/create-quote feat-4/my-profile

  3. Setup .env file - Copy the .env.example file, rename it to .env, and add the necessary environment variables. These variables include the Supabase URL and Supabase Anon Key, which can be obtained by contacting the project maintainers.

  4. Make changes - Make changes to the code and ensure that it is working properly.

  5. Test your changes - Test your changes thoroughly to ensure that there are no bugs or errors.

  6. Commit changes - Commit your changes and write a descriptive commit message.

  7. Push changes - Push your changes to your forked repository.

  8. Submit a pull request - Submit a pull request to the original repository and wait for the maintainers to review your changes.

  9. Respond to feedback - Respond to feedback from the maintainers and make any necessary changes.

  10. Get your changes merged - Once your changes have been approved, they will be merged into the main repository.

By following these guidelines, you can help us improve our project and make it better for everyone. Thank you for your contributions!