Skip to content

Latest commit

 

History

History
68 lines (36 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

68 lines (36 loc) · 3.09 KB
Raw

🎇 Contributing Guidelines

Thank you for your interest in contributing to FlutterFolio! We welcome contributions from everyone. Whether you're fixing a bug, improving the documentation, or adding a new feature, your contributions are appreciated.

💻 Before Contributing

Before sending your pull requests, make sure to read these guidelines:

  1. Familiarize yourself with the project by exploring the app and understanding its structure.

  2. Choose an issue from the Issues section to work on or create a new issue if you have an improvement in mind.

  3. Fork the repository and clone it to your local machine.

🔖 Steps to Contribute

Follow these steps to contribute to FlutterFolio:

  1. Fork the Repository: Click the "Fork" button at the top right of the repository's page to create your fork.

  2. Clone Your Fork: Clone your forked repository to your local machine using git clone.

  3. Create a Branch: Create a new branch for your contribution with a meaningful name. For example, if you're fixing a bug related to widget buttons, create a branch named fix-widget-button-bug.

  4. Make Changes: Make your changes in the code, following the project's guidelines.

  5. Commit Your Changes: Commit your changes with a clear and concise message describing your work.

  6. Push Changes: Push your changes to your forked repository on GitHub.

  7. Create a Pull Request (PR): Create a PR from your branch to the main branch of the original repository. Ensure that your PR includes a clear description of the changes you made.

  8. Review and Feedback: Be prepared for feedback and discussions on your PR. Make necessary adjustments based on feedback.

  9. PR Approval: Once your PR is approved by a maintainer, it will be merged into the project.

🧲 Pull Request Review Criteria

Please adhere to the following guidelines when submitting a PR:

  1. Fill out the PR Template with relevant information.

  2. Ensure your code follows the Flutter style guide.

  3. Your work should be original, and you must comment your code where necessary.

  4. Include issue numbers in your commit messages (e.g., "Fixes #123").

  5. Your solution should be better in terms of performance and other parameters compared to the previous work, if applicable.

📖 Resources

If you need help with Git, GitHub, or Flutter, here are some resources to get you started:

🤔 Need More Help?

If you have any questions or need assistance, don't hesitate to reach out to the project admins or mentors. We're here to help you make your contribution a success!

🎉 🎊 😃 Happy Contributing! 😃 🎊 🎉