Skip to content

Latest commit

 

History

History
117 lines (76 loc) · 5.59 KB

CONTRIBUTING.md

File metadata and controls

117 lines (76 loc) · 5.59 KB
Raw

Contributing to LogSuite

Thank you for considering contributing to LogSuite! We welcome contributions from the community to help make this project better. This document outlines the process for contributing and provides guidelines to ensure that contributions are consistent and maintainable.

Getting Started

  1. Fork the Repository: Fork the repository to your GitHub account by clicking the "Fork" button on the repository page.

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

    git clone https://github.com/your-username/logsuite.git
cd logsuite

  3. Create a Branch: Create a new branch for your feature or bugfix.

    git checkout -b my-feature-branch

  4. Set Up the Environment: Ensure you have the necessary dependencies installed.

    flutter pub get

Making Changes

  1. Develop Your Feature: Implement your feature or bugfix. Follow the existing code style and conventions.

  2. Testing: Ensure that your changes are well-tested. Add new tests if necessary.

    flutter test

  3. Commit Your Changes: Write clear and concise commit messages. Follow the convention of starting with a verb in the imperative mood, such as "Add", "Fix", or "Update".

    git add .
git commit -m "Add new feature"

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

    git push origin my-feature-branch

  5. Create a Pull Request: Navigate to the original repository and create a pull request from your fork. Provide a clear description of your changes and the problem they solve.

Alternatively, contribute using GitHub Desktop

  1. Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.

  2. Clone the Repository:

    • If you haven't cloned the logsuite repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."

    • Choose the logsuite repository from the list of repositories on GitHub and clone it to your local machine.

      image

      image

  3. Switch to the Correct Branch:

    • Ensure you are on the branch that you want to submit a pull request for.

    • If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.

      image

  4. Make Changes: Make your changes to the code or files in the repository using your preferred code editor.

  5. Commit Changes:

    • In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
    • Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to " button to commit your changes to the local branch.

    image

  6. Push Changes to GitHub: After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.

    image

  7. Create a Pull Request:

  • Go to the GitHub website and navigate to your fork of the logsuite repository.

  • You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.

    image

  1. Review and Submit:

    • On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
    • Once you're satisfied, click the "Create pull request" button to submit your pull request.

  2. Wait for Review: Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the logsuite repository.

Code Guidelines

  • Follow Flutter Best Practices: Write clean, readable, and maintainable code. Follow the Effective Dart guidelines.

  • Documentation: Ensure your code is well-documented. Public methods should have clear and concise comments explaining their purpose and usage.

  • Testing: Write tests for your code. Ensure that existing tests pass before submitting a pull request.

  • Commit Messages: Use descriptive commit messages. Each commit should represent a single logical change.

Reporting Issues

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

Community

  • Be Respectful: Treat others with respect. Be constructive and considerate in your communication.
  • Collaborate: We encourage collaboration. Feel free to discuss your ideas in the issues or pull requests.

License

By contributing to LogSuite, you agree that your contributions will be licensed under the MIT License.

Thank you for contributing to LogSuite! We appreciate your support and look forward to your contributions.