How to use Pull Checklist
Step 1: Install Pull Checklist
To use Pull Checklist you need to go to our Github Marketplace page. From here follow the instructions on screen and select the most appropriate plan for you, or you and your team.
Step 2: Installing your repos
You'll then be taken through a flow that will enable you to install the relevant repositories to your account.
Step 3: Onboarding and Creating your first checklist
Once your repositories are synced, Pull Checklist provides a seamless onboarding process to help you get started. After completing the onboarding, you can create your first checklist by simply starting with an idea or objective in mind. Choose the relevant organization and repository, then click the "Create checklist" button to generate and save your checklist.
With Pull Checklist, you have the flexibility to design and tailor your checklist based on your specific needs. You can define a custom title, set custom check titles, and even create nested tasks using indentations. This allows you to structure your checklist in a way that aligns with your workflow and requirements.
Remember, you can add, update, and delete checks within your checklist as necessary. Additionally, you have the option to set specific rules for displaying the checklist under certain conditions, such as when a pull request (PR) contains a certain number of added lines or includes specific keywords like "reverts."
Feel free to iterate and refine your checklist based on your evolving processes and requirements. Pull Checklist empowers you to create a comprehensive and tailored checklist that suits your team's needs.
Step 4: Populating your checklist
Pull Checklist offers extensive flexibility when it comes to populating your checklist. You have full control over the content and structure of your checklist to ensure it meets your specific needs.
Custom Title and Check Titles: With Pull Checklist, you can add a custom title to your checklist that accurately reflects its purpose. This allows you to provide clear guidance to reviewers and contributors. Additionally, you can create custom check titles for each item within the checklist. This enables you to capture the specific tasks or requirements that need to be addressed during the code review process.
Nested Tasks with Indentations: Pull Checklist supports nested tasks, allowing you to create a hierarchical structure within your checklist. By using indentations, you can easily define subtasks and dependencies, providing a clear understanding of the relationships between different checklist items. This feature helps you organize and prioritize the code review process effectively.
Adding and Deleting Checks: You have the flexibility to create and delete any number of checks within your checklist. This allows you to adapt the checklist as your project evolves or when new requirements arise. By easily adding or removing checks, you can ensure that your checklist remains up-to-date and relevant to the specific code changes being reviewed.
Specific Rules for Checklist Display: Pull Checklist enables you to set specific rules that determine when your checklist should be displayed. For instance, you can define conditions such as displaying the checklist only when a pull request (PR) contains more than 500 lines of code or if the word "reverts" appears in the PR title. This flexibility allows you to tailor the checklist visibility based on the specific circumstances or criteria that are important for your team.
By utilizing the various customization options provided by Pull Checklist, you can create a comprehensive and tailored checklist that aligns with your team's specific requirements. This empowers your team to conduct thorough and efficient code reviews, ensuring that all necessary tasks and considerations are addressed.
Adding a check
Updating a check
Deleting a check
Step 5: Make the checklist blocking
One of the most powerful features of Pull Checklist is the ability to enforce checklist compliance for all pull requests (PRs). By checking the "enforce on merge" option in the interface, you can make it mandatory for every PR to adhere to the checklist before it can be merged.
Enforcing the checklist provides several key benefits. Firstly, it allows you to maintain an audit log of the tasks and requirements that need to be completed for each code change. This not only improves accountability but also ensures that all necessary steps are followed before merging.
Additionally, by making the checklist mandatory, you can ensure that code committers go through a structured process and provide a digital signature indicating their approval and completion of the checklist items. This helps in scenarios where collaboration with other teams or stakeholders is required, such as when updating website copy and coordinating with the marketing team, or ensuring the presence of unit tests and thorough testing for code changes.
By making checklist compliance a requirement for merging, Pull Checklist empowers you to establish a standardized and accountable workflow, enhancing code quality and collaboration within your development process.
Step 6: Raise a PR
When your team raises a pull request, Pull Checklist seamlessly integrates into the pull request workflow. The relevant checklist will automatically appear when the conditions you defined during the checklist setup process are met.
Pull Checklist functions as a Continuous Integration (CI) check, ensuring that the checklist is presented at the appropriate time during the PR review process. By configuring the conditions during checklist setup, you have the flexibility to specify when the checklist should be displayed. This can be based on various factors such as the number of added lines in the PR or the presence of specific keywords in the PR title.
By appearing as a CI check, Pull Checklist reinforces the importance of following the defined checklist for each PR. This helps to maintain consistency and adherence to your team's established processes and requirements. It ensures that the checklist is readily available during the review process, providing a comprehensive guide for reviewers to assess the completeness of the code changes.
With Pull Checklist as a CI check, you can streamline your PR workflow, improve code quality, and foster collaboration among your team members during the review process.