How to engage with the project¶

We use GitHub to host the source code, track bugs and requests, and run the build and release actions for qtpy-datalogger.

This page covers the first two: changing the source code and tracking issues. If you haven't used GitHub before, continue reading to learn how we do these with a GitHub-hosted project.

If you want to learn about the build and release actions, go to our Manage the package page.

Use issues¶

We do not follow any automated or formal processes for handling issues, but as a baseline:

• We use labels to categorize issues
• We require code changes to reference an issue

These sections explain how we use GitHub issues in the project.

Create an issue¶

Thank you for volunteering your time to describe a problem or ask for a new feature.

Please choose what best matches your topic.

Fix an issue¶

Thank you for volunteering your time to improve the code or documentation for qtpy-datalogger.

If you are new to coding, choose an issue from our good first issue list. We also label issues with help wanted if they are good candidates for experienced coders new to this project. However, you can choose any open issue that you want to fix.

When fixing an issue, follow the GitHub flow for using issues.

1. Select an issue
   • Open the issues list and select an issue
   • Assign yourself to the issue
   • Add the active label to it
   • Ask questions in the issue if you want more information
2. Create a branch and make code changes
   • Ask questions in the issue as you encounter obstacles
   • Add notes to the issue as you make progress
3. Open a PR with the proposed fixes
   • Include this keyword phrase in the description, where ID is the issue's number

     Closes #ID
     

   • Respond to feedback
4. Close the issue
   • Complete the pull request
   • Remove the active label from the issue

For specific workflows about using git and running the tests and analyzers for qtpy-datalogger, go to our Workflows page.

Triage new issues¶

When someone creates a new issue, GitHub adds an inbox label. Depending on the type of the issue that they selected, GitHub adds additional labels.

Once we notice a new issue, we can help it get the right attention by categorizing them.

1. Filter for new bug reports and feature requests with the inbox label
2. Use the full label list to add and remove labels to match the issue's topic
3. Remove the inbox label to remove it from the triage list

Labels¶

These are the most common labels that we use.

See the full label list for other views of this project's issues.

Change source code¶

This project uses the same GitHub repository for its source code and website documentation. Changes to either happen with pull requests.

Before opening a pull request, please select an issue from the issues list and assign it to yourself.

Open a pull request¶

Once you own an issue, follow the GitHub flow for collaborating with pull requests.

1. Create a branch
2. Commit changes to it
3. Publish your branch
4. Create a pull request
5. Respond to feedback and questions

For specific workflows about using git and running the tests and analyzers for qtpy-datalogger, go to our Workflows page.

Review a pull request¶

We require one maintainer to approve the changes in pull requests. Follow the GitHub flow for reviewing pull requests.

1. Open the pull request page
2. Inspect the changed files
3. Add feedback or ask questions
4. Approve the PR when you're satisfied with the proposed changes