Skip to content

Commit 7cb261c

Browse files
authored
chore: enhance contributing guidelines (#970)
1 parent 2623722 commit 7cb261c

6 files changed

Lines changed: 117 additions & 28 deletions

File tree

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Description
10+
<!-- A clear and concise description of what the bug is. -->
11+
12+
## Reproduction
13+
<!-- Please provide a minimal code snippet or repository that reproduces the issue. You can follow a [Minimum Reproducible Example](https://stackoverflow.com/help/minimal-reproducible-example)-->
14+
15+
```js
16+
const piscina = require('piscina');
17+
// ... (Add reproduction code here)
18+
```
19+
20+
## Environment
21+
- **OS**:
22+
- **Node.js version**:
23+
- **Piscina version**:
24+
25+
## Expected Behavior
26+
<!-- What did you expect to happen? -->
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Goal
10+
<!-- What problem are you trying to solve? -->
11+
12+
## Proposal
13+
<!-- A concise description of the solution you'd like.If this involves an API change, please describe the new API. -->
14+
15+
## Alternatives
16+
<!-- What other solutions have you considered? -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Overview
2+
3+
<!-- Briefly explain the goal of this Pull Request. -->
4+
5+
## Category
6+
7+
- [ ] Bug fix (non-breaking change which fixes an issue)
8+
- [ ] New feature (non-breaking change which adds functionality)
9+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
10+
- [ ] Documentation
11+
- [ ] Maintenance (refactoring, dependency updates, etc.)
12+
13+
## Contribution Checklist
14+
15+
<!-- Please verify the following before submitting: -->
16+
17+
- [ ] I have reviewed the [guidelines](../CONTRIBUTING.md) for this project.
18+
- [ ] I agree to follow the [Code of Conduct](../CODE_OF_CONDUCT.md).
19+
- [ ] My code adheres to the project's style and conventions.
20+
- [ ] I have added tests to cover my changes.
21+
- [ ] All tests passed locally.
22+
- [ ] I have updated relevant documentation.
23+
24+
## DCO Sign-off
25+
26+
- [ ] I certify that I have the right to submit this contribution under the open source license ([DCO 1.1](../CONTRIBUTING.md#developers-certificate-of-origin-11)).

CONTRIBUTING

Lines changed: 0 additions & 27 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Piscina is an OPEN Open Source Project
2+
3+
## What?
4+
5+
Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.
6+
7+
## Rules
8+
9+
There are a few basic ground-rules for contributors:
10+
11+
1. **No `--force` pushes** on `current` or any `vX` branches, or modifying the `git` history in any way after a PR has been merged.
12+
2. **Non-current branches** ought to be used for ongoing work.
13+
3. **External API changes and significant modifications** ought to be subject to an **internal pull-request** to solicit feedback from other contributors.
14+
4. Internal pull-requests to solicit feedback are *encouraged* for any other non-trivial contribution but left to the discretion of the contributor.
15+
5. Contributors should attempt to adhere to the prevailing code-style.
16+
6. At least two contributors, or one core member, must approve pull requests before merging.
17+
7. All integrated CI services must be green before a pull request can be merged.
18+
8. If it is not possible to reach a consensus in a pull request, the decision is left to the lead maintainer's team.
19+
9. Semantic Versioning is used.
20+
21+
## Releases
22+
23+
Declaring formal releases remains the prerogative of the project maintainer.
24+
25+
## Previous Versions
26+
Every version of Piscina has its own branch. All Piscina related changes should be based on the corresponding branch.
27+
28+
Piscina's adhere to one active release line and a maintanance release line within a single year, rotating on a yearly basis.
29+
30+
Version | Branch | Status
31+
------- | ------ | ------
32+
current | branch | main
33+
v4.x | branch | v4
34+
v5.x | branch | v5
35+
36+
37+
## Developer's Certificate of Origin 1.1
38+
By making a contribution to this project, I certify that:
39+
40+
(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
41+
42+
(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
43+
44+
(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
45+
46+
(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
47+
48+
-----------------------------------------

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2020 James M Snell and the Piscina contributors
3+
Copyright (c) 2026 James M Snell and the Piscina contributors
44

55
Piscina contributors listed at https://github.com/jasnell/piscina#the-team and
66
in the README file.

0 commit comments

Comments
 (0)