GitHub features used on text_formatter
#
We hosted text_formatter
on GitHub since we started
to develop the code. As the project were growing, we decided to implement some GitHub special features.
GitHub actions#
We are using GitHub actions to automate tests and processes. Those workflows are
stored right here. They are used
to make tests on the code before/after merging commits to the main
branch.
The greetings
workflow#
When you fill an issue/pull request for the first time, a special workflow
named greetings
will send you a message.
On issues, it says:
Thanks for your first issue! The
text_formatter
maintainers will try to help or support you, as soon as possible. We really appreciate your recent contribution.
On pull requests, it says:
Thanks for your first pull request! We really appreciate your contribution. Now, you may need a maintainer to review the code and give you some style suggestions.
Note
This workflow is currently failing when the PR is submitted by a bot. See the GitHub issue #40 to see the full details.
The lock-threads
workflow#
This workflow closes issues and pull requests with a certain period of inactivity. See the reference for the workflow here.
Python tests workflows#
See “Continous Integrations (CI) used on text_formatter” to learn about the CI used to test the Python code.
GitHub bots#
These bots are used on the GitHub interface for issues and pull requests.
- Dependabot [1]
This bot is only used to keep some GitHub actions fresh.
- No-response [2]
This bot has a more-complex function. When we want more information/response from the author of a pull request/issue, we apply an
Awaiting response
label. After 15 days, if the author hasn’t answered, this bot will close it.
GitHub projects#
Diego Ramirez has a personal project board for text_formatter
(see it here). But the
repository has more boards, related to some specific topics. See them here.
GitHub issue templates#
Read about how to use those templates on “Contributing on text_formatter”.
Footnotes