Contributing
What the Pipedash repository accepts and where. Covers bug reports, feature requests, pull requests, new providers, the issue templates, the PR template and CI checks.
The Pipedash repository accepts bug reports, feature requests, pull requests and new provider plugins. The project has no formal contribution guidelines yet. This page lists the templates and checks.
| Contribution | Where |
|---|---|
| Bug report | GitHub issue, using the bug report template |
| Feature request | GitHub issue, using the feature request template |
| Pull request | GitHub pull request, using the PR template |
| New provider | A pull request with a plugin crate, or a GitHub issue requesting it |
Bug reports and feature requests
Both go to GitHub issues. The repository has 2 issue templates.
- Bug report: asks for a description, steps to reproduce, the expected behavior, screenshots, desktop or phone details and extra context.
- Feature request: asks for the problem, the proposed solution, alternatives considered and extra context.
A provider that Pipedash does not support goes in an issue, or arrives as a plugin implementation.
Pull requests
The development page covers the tool setup. The pull request template has these sections:
- Changes: a short description of the change and the issue it relates to.
- Checklist before merging: 4 boxes. The author reviewed the code, tested the changes and updated the documentation, and the changes do not break existing functionality.
- Screenshots: for UI changes.
- Anything else: any other context.
The PR workflow runs on pull requests that target main. It has 3 jobs:
| Job | Task it runs | Platforms |
|---|---|---|
| ESLint | mise run lint:front | Ubuntu |
| rustfmt | mise run fmt:back:check | Ubuntu |
| Clippy | mise run lint:back | Ubuntu, macOS and Windows |
mise run ci runs the format check, the lint and the type check locally. mise run precommit formats first and then lints and checks.
A stale bot marks an issue after 60 days without activity and closes it 7 days later. It marks a pull request after 30 days and closes it 14 days later.
Providers
A new CI/CD provider is a new crate that implements the Plugin trait. The plugin development page lists the trait methods, the file layout and the places to register the crate. The 7 existing plugins serve as references, and the providers index lists them.
License
Pipedash is licensed under GPL-3.0. The repository LICENSE file has the full text of the GNU General Public License version 3.