Skip to content

Commit 6985aad

Browse files
authored
Merge pull request #516 from asgrim/contributing-templates
Contributing templates
2 parents adfe984 + db110ff commit 6985aad

3 files changed

Lines changed: 44 additions & 1 deletion

File tree

.github/pull_request_template.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!--- IMPORTANT - READ BEFORE SUBMITTING YOUR PR -->
2+
<!--- If you have not discussed this change with us this change before -->
3+
<!--- submitting a Pull Request, you may be duplicating work already in -->
4+
<!--- progress. Please either open an issue (for bugs), or create a -->
5+
<!--- discussion (for features), and discuss the change BEFORE working -->
6+
<!--- on it, so you are not wasting your time... -->
7+
8+
## PR submitter checklist
9+
10+
- [ ] I have read [CONTRIBUTING.md](../CONTRIBUTING.md)
11+
- [ ] I discussed this <bug|feature> with the maintainers in #<issue_number> (complete as appropriate)
12+
- [ ] I have added appropriate tests
13+
- [ ] I confirm that I have the right to submit this under the project's open source licence

.github/workflows/build-assets.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ jobs:
7676
- ubuntu-24.04-arm
7777
- macos-15-intel
7878
- macos-26
79-
- windows-2025
79+
# - windows-2025 # disabled - https://github.com/crazywhalecc/static-php-cli/issues/1039
8080
permissions:
8181
# id-token:write is required for build provenance attestation.
8282
id-token: write

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing to PIE
2+
3+
Thank you for taking an interest in contributing to PIE.
4+
5+
> [!IMPORTANT]
6+
> The TL;DR version of this is please either [open an issue](https://github.com/php/pie/issues) if you think you have
7+
> found a bug, or [create a discussion](https://github.com/php/pie/discussions) if you have an idea for a new feature,
8+
> **BEFORE** starting work on any code changes. Submitting a pull request without checking first may be duplicating
9+
> work that is already in progress!
10+
11+
## Reporting bugs
12+
13+
If you think you have a bug, please [open an issue](https://github.com/php/pie/issues), and include:
14+
15+
- What platform and PIE version you're using
16+
- The steps to reproduce the issue - please use the `-v` verbose flag (or higher)
17+
- Complete error messages and/or logs, including stack traces (hint: use `-v` for verbose), but please redact sensitive information
18+
19+
## Submitting PRs
20+
21+
Please **do not** just submit PRs for features or ideas without discussing them first. **Start by
22+
[creating a discussion](https://github.com/php/pie/discussions) first** if there is not already an open discussion or
23+
issue. If there is already an open discussion or issue, please comment and wait for feedback before starting any work.
24+
This is because the work may already be in progress or being investigated already. The PIE project is actively being
25+
developed, and many features are already in discussion or being developed, so if you do not discuss with us first, you
26+
may be duplicating work already in progress.
27+
28+
> [!TIP]
29+
> We try to stay on top of issues already being worked on with the `maintainer investigating` purple label. If you see
30+
> this on an issue, it is very likely we are already looking into this.

0 commit comments

Comments
 (0)