@daiyam/artifact-gh-issuehub 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.artifactrc.yml +3 -0
- package/LICENSE +22 -0
- package/README.md +24 -0
- package/configs/.github/DISCUSSION_TEMPLATE/issue-triage.yml +61 -0
- package/configs/.github/ISSUE_TEMPLATE/config.yml +5 -0
- package/configs/.github/ISSUE_TEMPLATE/preapproved.yml +26 -0
- package/configs/.github/workflows/close-invalid-issue.yml +28 -0
- package/configs/CODE_OF_CONDUCT.md +91 -0
- package/configs/CONTRIBUTING.md +114 -0
- package/package.json +20 -0
package/.artifactrc.yml
ADDED
package/LICENSE
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
Copyright (c) 2025-present Baptiste Augrain
|
|
2
|
+
|
|
3
|
+
Permission is hereby granted, free of charge, to any person
|
|
4
|
+
obtaining a copy of this software and associated documentation
|
|
5
|
+
files (the "Software"), to deal in the Software without
|
|
6
|
+
restriction, including without limitation the rights to use,
|
|
7
|
+
copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
8
|
+
copies of the Software, and to permit persons to whom the
|
|
9
|
+
Software is furnished to do so, subject to the following
|
|
10
|
+
conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be
|
|
13
|
+
included in all copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
16
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|
17
|
+
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
18
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|
19
|
+
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
20
|
+
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
21
|
+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|
22
|
+
OTHER DEALINGS IN THE SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
[@daiyam/artifact-gh-issuehub](https://github.com/daiyam/artifact-configs/tree/master/packages/gh-issuehub)
|
|
2
|
+
===========================================================================================================
|
|
3
|
+
|
|
4
|
+
[](./LICENSE)
|
|
5
|
+
[](https://www.npmjs.com/package/@daiyam/artifact-gh-issuehub)
|
|
6
|
+
|
|
7
|
+
The configuration to use GitHub Issues as an issue tracker and accept issue report in GitHub Discussions.
|
|
8
|
+
|
|
9
|
+
Getting Started
|
|
10
|
+
---------------
|
|
11
|
+
|
|
12
|
+
```sh
|
|
13
|
+
mkdir myproject
|
|
14
|
+
cd myproject
|
|
15
|
+
npm init -y
|
|
16
|
+
artifact add @daiyam/gh-issuehub
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
License
|
|
20
|
+
-------
|
|
21
|
+
|
|
22
|
+
Copyright © 2025-present Baptiste Augrain
|
|
23
|
+
|
|
24
|
+
Licensed under the [MIT license](https://opensource.org/licenses/MIT).
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
labels: ["S-needs-triage"]
|
|
2
|
+
body:
|
|
3
|
+
- type: markdown
|
|
4
|
+
attributes:
|
|
5
|
+
value: |-
|
|
6
|
+
> [!IMPORTANT]
|
|
7
|
+
> Please read through [the Discussion rules](https://github.com/REPOSITORY_SLUG/discussions/1) and check for both existing [Discussions](https://github.com/REPOSITORY_SLUG/discussions?discussions_q=) and [Issues](https://github.com/REPOSITORY_SLUG/issues?q=sort%3Areactions-desc) prior to opening a new Discussion.
|
|
8
|
+
- type: markdown
|
|
9
|
+
attributes:
|
|
10
|
+
value: "# Issue Details"
|
|
11
|
+
- type: textarea
|
|
12
|
+
attributes:
|
|
13
|
+
label: Issue Description
|
|
14
|
+
description: |-
|
|
15
|
+
Provide a detailed description of the issue. Include relevant informations.
|
|
16
|
+
validations:
|
|
17
|
+
required: true
|
|
18
|
+
- type: textarea
|
|
19
|
+
attributes:
|
|
20
|
+
label: Expected Behavior
|
|
21
|
+
description: |-
|
|
22
|
+
Describe how you expect this project to behave in this situation. Include any relevant documentation links.
|
|
23
|
+
validations:
|
|
24
|
+
required: true
|
|
25
|
+
- type: textarea
|
|
26
|
+
attributes:
|
|
27
|
+
label: Actual Behavior
|
|
28
|
+
description: |-
|
|
29
|
+
Describe how this project actually behaves in this situation. If it is not immediately obvious how the actual behavior differs from the expected behavior described above, please be sure to mention the deviation specifically.
|
|
30
|
+
validations:
|
|
31
|
+
required: true
|
|
32
|
+
- type: textarea
|
|
33
|
+
attributes:
|
|
34
|
+
label: Reproduction Steps
|
|
35
|
+
description: |-
|
|
36
|
+
Provide a detailed set of step-by-step instructions for reproducing this issue.
|
|
37
|
+
validations:
|
|
38
|
+
required: true
|
|
39
|
+
- type: textarea
|
|
40
|
+
attributes:
|
|
41
|
+
label: Version
|
|
42
|
+
description: Paste the output the version here.
|
|
43
|
+
render: text
|
|
44
|
+
validations:
|
|
45
|
+
required: true
|
|
46
|
+
- type: markdown
|
|
47
|
+
attributes:
|
|
48
|
+
value: |-
|
|
49
|
+
# User Acknowledgements
|
|
50
|
+
> [!TIP]
|
|
51
|
+
> Use these links to review the existing [Discussions](https://github.com/REPOSITORY_SLUG/discussions?discussions_q=) and [Issues](https://github.com/REPOSITORY_SLUG/issues?q=sort%3Areactions-desc).
|
|
52
|
+
- type: checkboxes
|
|
53
|
+
attributes:
|
|
54
|
+
label: "I acknowledge that:"
|
|
55
|
+
options:
|
|
56
|
+
- label: I have reviewed the FAQ and confirm that my issue is NOT among them.
|
|
57
|
+
required: true
|
|
58
|
+
- label: I have searched the repository (both open and closed Discussions and Issues) and confirm this is not a duplicate of an existing issue or discussion.
|
|
59
|
+
required: true
|
|
60
|
+
- label: I have checked the "Preview" tab on all text fields to ensure that everything looks right, and have wrapped all configuration and code in code blocks with a group of three backticks (` ``` `) on separate lines.
|
|
61
|
+
required: true
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
blank_issues_enabled: false
|
|
2
|
+
contact_links:
|
|
3
|
+
- name: Features, Bug Reports, Questions
|
|
4
|
+
url: https://github.com/REPOSITORY_SLUG/discussions/new/choose
|
|
5
|
+
about: Our preferred starting point if you have any questions or suggestions about configuration, features or behavior.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
name: Pre-Discussed and Approved Topics
|
|
2
|
+
description: |-
|
|
3
|
+
Only for topics already discussed and approved in the GitHub Discussions section.
|
|
4
|
+
body:
|
|
5
|
+
- type: markdown
|
|
6
|
+
attributes:
|
|
7
|
+
value: |-
|
|
8
|
+
This project doesn't accept Issues directly. Please prefer GitHub Discussions. See: https://github.com/REPOSITORY_SLUG/issues/1
|
|
9
|
+
- type: checkboxes
|
|
10
|
+
id: checkbox
|
|
11
|
+
attributes:
|
|
12
|
+
label: 'Sanity check'
|
|
13
|
+
options:
|
|
14
|
+
- label: |-
|
|
15
|
+
I read https://github.com/REPOSITORY_SLUG/issues/1
|
|
16
|
+
required: true
|
|
17
|
+
- type: textarea
|
|
18
|
+
id: body
|
|
19
|
+
attributes:
|
|
20
|
+
label: Body
|
|
21
|
+
value: |-
|
|
22
|
+
DON'T OPEN NEW ISSUES DIRECTLY, PLEASE USE THE DISCUSSIONS SECTION.
|
|
23
|
+
|
|
24
|
+
I DIDN'T READ THE ABOVE LINE. PLEASE CLOSE THIS ISSUE.
|
|
25
|
+
validations:
|
|
26
|
+
required: true
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
name: Close Invalid Issue
|
|
2
|
+
on:
|
|
3
|
+
issues:
|
|
4
|
+
types: [opened]
|
|
5
|
+
jobs:
|
|
6
|
+
close-invalid-issue:
|
|
7
|
+
name: Close invalid issue
|
|
8
|
+
runs-on: ubuntu-latest
|
|
9
|
+
permissions:
|
|
10
|
+
issues: write
|
|
11
|
+
steps:
|
|
12
|
+
- name: Close invalid issue
|
|
13
|
+
run: |
|
|
14
|
+
set -e # Exit if one of commands exit with non-zero exit code
|
|
15
|
+
set -u # Treat unset variables and parameters other than the special parameters '@' or '*' as an error
|
|
16
|
+
set -o pipefail # Any command failed in the pipe fails the whole pipe
|
|
17
|
+
|
|
18
|
+
BODY="$( gh issue view "${ISSUE}" --json body )"
|
|
19
|
+
|
|
20
|
+
if [[ "${BODY}" =~ "CLOSE THIS ISSUE" ]]; then
|
|
21
|
+
gh issue edit "${ISSUE}" --add-label "S-not-preapproved"
|
|
22
|
+
gh issue close "${ISSUE}" --comment "Please don't open issues directly, use GitHub Discussions instead. See: https://github.com/zokugun/REPOSITORY_SLUG/issues/1"
|
|
23
|
+
gh issue lock "${ISSUE}"
|
|
24
|
+
fi
|
|
25
|
+
env:
|
|
26
|
+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
27
|
+
GH_REPO: ${{ github.repository }}
|
|
28
|
+
ISSUE: ${{ github.event.issue.number }}
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
# Contributor Covenant 3.0 Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
We pledge to make our community welcoming, safe, and equitable for all.
|
|
6
|
+
|
|
7
|
+
We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
## Encouraged Behaviors
|
|
11
|
+
|
|
12
|
+
While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.
|
|
13
|
+
|
|
14
|
+
With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:
|
|
15
|
+
|
|
16
|
+
1. Respecting the **purpose of our community**, our activities, and our ways of gathering.
|
|
17
|
+
2. Engaging **kindly and honestly** with others.
|
|
18
|
+
3. Respecting **different viewpoints** and experiences.
|
|
19
|
+
4. **Taking responsibility** for our actions and contributions.
|
|
20
|
+
5. Gracefully giving and accepting **constructive feedback**.
|
|
21
|
+
6. Committing to **repairing harm** when it occurs.
|
|
22
|
+
7. Behaving in other ways that promote and sustain the **well-being of our community**.
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
## Restricted Behaviors
|
|
26
|
+
|
|
27
|
+
We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.
|
|
28
|
+
|
|
29
|
+
1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
|
|
30
|
+
2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
|
|
31
|
+
3. **Stereotyping or discrimination.** Characterizing anyone’s personality or behavior on the basis of immutable identities or traits.
|
|
32
|
+
4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
|
|
33
|
+
5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission.
|
|
34
|
+
6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group.
|
|
35
|
+
7. Behaving in other ways that **threaten the well-being** of our community.
|
|
36
|
+
|
|
37
|
+
### Other Restrictions
|
|
38
|
+
|
|
39
|
+
1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
|
|
40
|
+
2. **Failing to credit sources.** Not properly crediting the sources of content you contribute.
|
|
41
|
+
3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community.
|
|
42
|
+
4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors.
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
## Reporting an Issue
|
|
46
|
+
|
|
47
|
+
Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.
|
|
48
|
+
|
|
49
|
+
When an incident does occur, it is important to report it promptly. To report a possible violation, **[NOTE: describe your means of reporting here.]**
|
|
50
|
+
|
|
51
|
+
Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
## Addressing and Repairing Harm
|
|
55
|
+
|
|
56
|
+
**[NOTE: The remedies and repairs outlined below are suggestions based on best practices in code of conduct enforcement. If your community has its own established enforcement process, be sure to edit this section to describe your own policies.]**
|
|
57
|
+
|
|
58
|
+
If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.
|
|
59
|
+
|
|
60
|
+
1) Warning
|
|
61
|
+
1) Event: A violation involving a single incident or series of incidents.
|
|
62
|
+
2) Consequence: A private, written warning from the Community Moderators.
|
|
63
|
+
3) Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
|
|
64
|
+
2) Temporarily Limited Activities
|
|
65
|
+
1) Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.
|
|
66
|
+
2) Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members.
|
|
67
|
+
3) Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over.
|
|
68
|
+
3) Temporary Suspension
|
|
69
|
+
1) Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.
|
|
70
|
+
2) Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions.
|
|
71
|
+
3) Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted.
|
|
72
|
+
4) Permanent Ban
|
|
73
|
+
1) Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member.
|
|
74
|
+
2) Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior.
|
|
75
|
+
3) Repair: There is no possible repair in cases of this severity.
|
|
76
|
+
|
|
77
|
+
This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community.
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
## Scope
|
|
81
|
+
|
|
82
|
+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
## Attribution
|
|
86
|
+
|
|
87
|
+
This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/).
|
|
88
|
+
|
|
89
|
+
Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/)
|
|
90
|
+
|
|
91
|
+
For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozilla’s code of conduct team](https://github.com/mozilla/inclusion).
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
|
|
4
|
+
|
|
5
|
+
This document is intended for anyone considering opening an **issue**, **discussion** or **pull request**.
|
|
6
|
+
|
|
7
|
+
> [!NOTE]
|
|
8
|
+
>
|
|
9
|
+
> This is a personal project that I maintain in my free time.
|
|
10
|
+
> If you're expecting me to dedicate my personal time to fixing bugs, maintaining features, and reviewing code, I do kindly ask you spend a few minutes reading this document.
|
|
11
|
+
> Thank you. :heart:
|
|
12
|
+
|
|
13
|
+
#### Table Of Contents
|
|
14
|
+
|
|
15
|
+
- [Code of Conduct](#code-of-conduct)
|
|
16
|
+
- [Users are not allowed to create Issues directly](#users-are-not-allowed-to-create-issues-directly)
|
|
17
|
+
- [I have a bug! / Something isn't working](#i-have-a-bug--something-isnt-working)
|
|
18
|
+
- [I have an idea for a feature](#i-have-an-idea-for-a-feature)
|
|
19
|
+
- [I want to make changes](#i-want-to-make-changes)
|
|
20
|
+
- [Spread the word](#spread-the-word)
|
|
21
|
+
- [Support the project financially](#support-the-project-financially)
|
|
22
|
+
|
|
23
|
+
## Code of Conduct
|
|
24
|
+
|
|
25
|
+
This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
|
|
26
|
+
|
|
27
|
+
## Users are not allowed to create Issues directly
|
|
28
|
+
|
|
29
|
+
Users are not allowed to create Issues directly in this repository - we ask that you create a [Discussion] first.
|
|
30
|
+
|
|
31
|
+
This project **does not use the issue tracker for discussion or feature requests**. Instead, we use GitHub [discussions] for that. Once a discussion reaches a point where a well-understood, actionable item is identified, it is moved to the issue tracker. **This pattern makes it easier for maintainers or contributors to find issues to work on since every issue is ready to be worked on**.
|
|
32
|
+
|
|
33
|
+
Any Discussion which clearly identifies a problem and can be confirmed or reproduced will be converted to an Issue by a maintainer, so as a user finding a valid problem you don't do any extra work anyway. Thank you.
|
|
34
|
+
|
|
35
|
+
[Discussion]: https://github.com/REPOSITORY_SLUG/discussions
|
|
36
|
+
[discussions]: https://github.com/REPOSITORY_SLUG/discussions
|
|
37
|
+
|
|
38
|
+
## I have a bug! / Something isn't working
|
|
39
|
+
|
|
40
|
+
First, search the issue tracker and discussions for similar issues.<br />
|
|
41
|
+
Tip: also search for [closed issues] and [closed discussions] — your issue might have already been fixed!
|
|
42
|
+
|
|
43
|
+
> [!NOTE]
|
|
44
|
+
>
|
|
45
|
+
> If there is an _open_ issue or discussion that matches your problem, **please do not comment on it unless you have valuable insight to add**.
|
|
46
|
+
>
|
|
47
|
+
> Use the handy upvote button for discussions, and/or emoji reactions on both discussions and issues, which are a visible yet non-disruptive way to show your support.
|
|
48
|
+
|
|
49
|
+
If your issue hasn't been reported already, open an ["Issue Triage"] discussion and make sure to fill in the template **completely**. They are vital for maintainers to figure out important details about your setup.
|
|
50
|
+
|
|
51
|
+
> [!WARNING]
|
|
52
|
+
>
|
|
53
|
+
> Please make sure that you _only_ use the "Issue Triage" category for reporting bugs — thank you!
|
|
54
|
+
|
|
55
|
+
[closed issues]: https://github.com/REPOSITORY_SLUG/issues?q=is%3Aissue%20state%3Aclosed
|
|
56
|
+
[closed discussions]: https://github.com/REPOSITORY_SLUG/discussions?discussions_q=is%3Aclosed
|
|
57
|
+
["Issue Triage"]: https://github.com/REPOSITORY_SLUG/discussions/new?category=issue-triage
|
|
58
|
+
|
|
59
|
+
## I have an idea for a feature
|
|
60
|
+
|
|
61
|
+
Like bug reports, first search through both issues and discussions and try to find if your feature has already been requested. Otherwise, open a discussion in the ["Feature Requests, Ideas"] category.
|
|
62
|
+
|
|
63
|
+
["Feature Requests, Ideas"]: https://github.com/REPOSITORY_SLUG/discussions/new?category=feature-requests-ideas
|
|
64
|
+
|
|
65
|
+
## I want to make changes
|
|
66
|
+
|
|
67
|
+
Small and trivial improvements can be submitted without any discussion.
|
|
68
|
+
|
|
69
|
+
**For non-trivial changes**, pull requests should be associated with a **previously accepted issue**.<br />
|
|
70
|
+
It's always better to ask for prior approval and discuss what you want to do before doing it.
|
|
71
|
+
|
|
72
|
+
Discussing that you want to do something doesn't put any obligations on you. If you don't want to start the discussion just because you're afraid that you won't do it. Don't be afraid!
|
|
73
|
+
|
|
74
|
+
> [!NOTE]
|
|
75
|
+
>
|
|
76
|
+
> **Pull requests are NOT a place to discuss feature design.** Please do not open a WIP pull request to discuss a feature. Instead, use a discussion and link to your branch.
|
|
77
|
+
|
|
78
|
+
### Code hygiene
|
|
79
|
+
|
|
80
|
+
When implementing features and bug fixes, please stick to the structure of the codebase as much as possible and do not take this as an opportunity to do some "refactoring along the way".
|
|
81
|
+
|
|
82
|
+
Similarly:
|
|
83
|
+
- **Make your changes** following our code standards
|
|
84
|
+
- **Test your changes** thoroughly
|
|
85
|
+
- **Update documentation** if needed
|
|
86
|
+
- **Commit your changes** with clear, descriptive commit messages
|
|
87
|
+
|
|
88
|
+
## Spread the word
|
|
89
|
+
|
|
90
|
+
Do you like the project?
|
|
91
|
+
|
|
92
|
+
* Spread the word in social networks!
|
|
93
|
+
* Talk about it to your colleagues and friends
|
|
94
|
+
* Write a blogpost
|
|
95
|
+
* Record a YouTube video
|
|
96
|
+
|
|
97
|
+
## Support the project financially
|
|
98
|
+
|
|
99
|
+
Supporting the project financially counts as a contribution (even if it's just a $1/month).
|
|
100
|
+
|
|
101
|
+
<table>
|
|
102
|
+
<tr>
|
|
103
|
+
<td><img src="https://raw.githubusercontent.com/daiyam/assets/master/icons/256/funding_kofi.png" alt="Ko-fi" width="80px" height="80px"></td>
|
|
104
|
+
<td><a href="https://ko-fi.com/daiyam" target="_blank">ko-fi.com/daiyam</a></td>
|
|
105
|
+
</tr>
|
|
106
|
+
<tr>
|
|
107
|
+
<td><img src="https://raw.githubusercontent.com/daiyam/assets/master/icons/256/funding_liberapay.png" alt="Liberapay" width="80px" height="80px"></td>
|
|
108
|
+
<td><a href="https://liberapay.com/daiyam/donate" target="_blank">liberapay.com/daiyam/donate</a></td>
|
|
109
|
+
</tr>
|
|
110
|
+
<tr>
|
|
111
|
+
<td><img src="https://raw.githubusercontent.com/daiyam/assets/master/icons/256/funding_paypal.png" alt="PayPal" width="80px" height="80px"></td>
|
|
112
|
+
<td><a href="https://paypal.me/daiyam99" target="_blank">paypal.me/daiyam99</a></td>
|
|
113
|
+
</tr>
|
|
114
|
+
</table>
|
package/package.json
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@daiyam/artifact-gh-issuehub",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "",
|
|
5
|
+
"author": {
|
|
6
|
+
"name": "Baptiste Augrain",
|
|
7
|
+
"email": "daiyam@zokugun.org"
|
|
8
|
+
},
|
|
9
|
+
"license": "MIT",
|
|
10
|
+
"homepage": "https://github.com/daiyam/artifact-configs/tree/master/packages/gh-issuehub",
|
|
11
|
+
"repository": {
|
|
12
|
+
"type": "git",
|
|
13
|
+
"url": "https://github.com/daiyam/artifact-configs.git"
|
|
14
|
+
},
|
|
15
|
+
"bugs": {
|
|
16
|
+
"url": "https://github.com/daiyam/artifact-configs/issues"
|
|
17
|
+
},
|
|
18
|
+
"keywords": [],
|
|
19
|
+
"gitHead": "5fff6c16ace6953d55a3daee53ac9896ebf53914"
|
|
20
|
+
}
|