Skip to content

Issue Tracking and Pull Requests

Amaan Lari edited this page Feb 16, 2025 · 1 revision

Efficient issue tracking and well-structured pull requests (PRs) are vital for maintaining the quality and consistency of the Blogger Hub project. This guide outlines the processes for tracking issues and submitting PRs.

Issue Tracking:

  1. Accessing Issues:

  2. Reporting a New Issue:

    • Click on "New Issue" in the Issues tab.
    • Provide a clear and descriptive title.
    • Detail the issue, including steps to reproduce, expected behavior, and any relevant screenshots or logs.
  3. Managing Existing Issues:

    • Review open issues to find one you'd like to address.
    • Comment on the issue with your proposed approach.
    • Priority is given to the first contributor who comments with a viable solution.
    • Once your approach is approved, the issue will be assigned to you.

Pull Requests:

  1. Before You Start:

    • Ensure the issue you're addressing is assigned to you.
    • Fork the repository and create a new branch for your work.
  2. Making Changes:

    • Develop and test your changes thoroughly.
    • Adhere to the project's coding standards and guidelines.
  3. Submitting a Pull Request:

    • Push your changes to your forked repository.

    • Navigate to the main repository and click on "New Pull Request."

    • Ensure your PR title is concise and descriptive.

    • Use the following template for the PR description:

      **Summary:**
      Briefly explain the purpose of the PR.
      
      **Changes Introduced:**
      - List of changes made
      - Highlight any new features or bug fixes
      
      **Issue Reference:**
      Link to the issue being addressed (e.g., Closes #123)
      
      **Testing:**
      Describe the testing performed to ensure functionality.
      
      **Additional Notes:**
      Any additional information or context.
  4. Review Process:

    • After submission, your PR will undergo review by maintainers.
    • Be responsive to feedback and make necessary revisions promptly.
  5. Merging:

    • Once approved, your PR will be merged into the main codebase.
    • Ensure to sync your fork and local repository with the main branch post-merge.
Clone this wiki locally