Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 2.59 KB

CONTRIBUTING.md

File metadata and controls

54 lines (34 loc) · 2.59 KB
Raw

✨ Contributing Guidelines ✨

Thank you for your interest in contributing to our academia project! We appreciate your support and collaboration. To ensure a smooth contribution process, please follow these guidelines.

🍴 Fork the Repository

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine using git clone.

🚀 Project Setup

  1. Ensure you have Flutter SDK installed on your machine. If not, you can download it from the official Flutter website (https://flutter.dev).
  2. Install the required dependencies by running flutter pub get.

👩‍💻 Development Guidelines

  1. Familiarize yourself with the project's architecture, code structure, and existing features.
  2. Stick to the project's coding style and conventions.
  3. Use meaningful commit messages and include necessary documentation for your changes.
  4. All code changes must be accompanied by appropriate unit tests.

📚 State Management

We utilize GetX for state management in our academia project. Please ensure that any state management-related code or features you contribute use GetX exclusively.

📥 Submitting Pull Requests

  1. Create a new branch for your changes. Use a descriptive name related to the feature or bug fix you're working on.
  2. Make your changes, commit them, and push to your forked repository.
  3. Before pushing your changes run:
flutter analyze

Ensure that you fix the warnings and errors presented to you otherwise the tests will fail

  1. Open a pull request (PR) from your branch to the main branch of the main project repository.
  2. Provide a clear and concise description of the changes you've made in the PR, including any relevant information that would help reviewers understand the purpose and impact of your changes.

👥 Code Review and Merging

  1. The project maintainers will review your pull request.Once you fork the project , pull , switch branch , make changes , add , then commit.
  2. Address any feedback or comments provided during the code review process.
  3. Once your changes have been approved, they will be merged into the main repository.
  4. Congratulations! Your contributions are now part of the academia project.

📜 Code of Conduct

Please note that we have a Code of Conduct in place, and we expect all contributors to adhere to it. Be respectful, considerate, and professional when interacting with the project's community members.

If you have any questions or need further assistance, feel free to reach out to us through the project's communication channels.

Happy coding and thank you for your contributions! ✌️