Skip to content

Latest commit

 

History

History
83 lines (50 loc) · 3.23 KB

CONTRIBUTING.md

File metadata and controls

83 lines (50 loc) · 3.23 KB
Raw

Contributing Guidelines

Thank you for considering contributing to InnerQuest! We appreciate your interest and support in making this project better. By contributing, you become part of a community-driven effort to promote personal growth and productivity.

To ensure a smooth and collaborative experience for all contributors, please read and follow these guidelines.

How to Contribute

  1. Fork the Repository: Start by forking the InnerQuest repository to your GitHub account.

  2. Clone the Repository: Clone your forked repository to your local machine:

    git clone https://github.com/Kushalrock/InnerQuest.git

  3. Create a Branch: Create a feature branch for your contribution:

    git checkout -b feature/your-feature-name

  4. Make Changes: Make your contributions, whether it's bug fixes, new features, improvements, or documentation updates.

  5. Testing: Ensure your changes don't introduce new issues. Test thoroughly and run the app to confirm everything works as expected.

  6. Commit Changes: Commit your changes with clear and concise messages:

    git commit -m "Your descriptive commit message"

  7. Push to Your Fork: Push your changes to your forked repository:

    git push origin feature/your-feature-name

  8. Create a Pull Request: Create a pull request (PR) from your feature branch to the main branch of the original InnerQuest repository. Please provide a clear and detailed description of your changes in the PR.

Code Style and Standards

  • Follow the Flutter and Dart coding guidelines.
  • Write clear and concise code with meaningful variable and function names.
  • Ensure your code is properly formatted by running flutter format.

Commit Messages

  • Use descriptive commit messages to explain your changes concisely.
  • Start your commit message with a verb in the present tense, such as "Add," "Fix," "Update," "Remove," etc.

Testing

  • Write tests for your code changes if applicable.
  • Ensure that your changes pass existing tests without causing regressions.

Documentation

  • Update or create documentation as needed for the changes you make.
  • Keep the README and other documentation up to date.

Licensing

  • Ensure that your contributions comply with the project's GNU GPL v3.0 License.
  • Contributions should respect the terms of the GPL-3.0, which include allowing others to view, modify, and distribute the source code, provided they also adhere to the GPL-3.0 license terms.
  • If you have questions or concerns regarding the GPL-3.0 license, please seek clarification from the project maintainers.

Be Respectful

  • Show respect and professionalism when interacting with other contributors.
  • Avoid offensive language and personal attacks.

Roadmap and Future Plans

  • Familiarize yourself with the project's roadmap and goals, and consider how your contributions align with these plans.

By following these contributing guidelines, you help maintain a positive and productive atmosphere within the InnerQuest community. Your contributions are highly valued, and together, we can make a significant impact on personal growth and productivity.

Thank you for your support and dedication to the InnerQuest project!