Skip to content

Latest commit

 

History

History
36 lines (21 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

36 lines (21 loc) · 1.86 KB

Contributing to Create Portfolio

Thank you for considering contributing to Create Portfolio! We welcome contributions from everyone. Below are some guidelines to help you get started.

How to Contribute

  1. Fork the Repository: Start by forking the repository and creating a new branch for your changes.

  2. Create/Find an Issue: Before making changes, please create or find existing issue on GitHub describing the changes you plan to make. This helps us track your contribution and provide feedback if needed.

  3. Setup Environment:

    • Copy the .env.sample file to .env.
    • Add the necessary environment variables, including the Supabase anon key and Supabase project URL which are required to run this project locally.

  4. Create a Branch: Create a new branch from main using the issue name or a descriptive title for your changes:

    git checkout -b issue-<issue-number>-<description>

  5. Build the Project: Ensure the build is smooth and error-free before making any changes. Run tests to verify everything is working as expected.

  6. Commit Messages: Use clear and concise commit messages. Follow the Conventional Commits style.

  7. Push Changes: Push your changes to your forked repository and to the branch you created.

  8. Create a Pull Request: Once your changes are ready, open a pull request against the main branch of the Create Portfolio repository. Please include a description of your changes and link to the related issue if applicable.

Reporting Issues

If you find a bug or have a feature request, please open an issue on GitHub. Include as much detail as possible to help us understand and address the issue.

Code of Conduct

Please note that all contributions are expected to adhere to our Code of Conduct.

Thank you for your contributions!