Skip to content

Commit 2e97863

Browse files
authored
Merge pull request #149 from nao1215/nchika/update-project-rule
Update project config
2 parents e37150f + 2c477be commit 2e97863

13 files changed

+308
-375
lines changed

.github/FUNDING.yml

-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
11
github: nao1215
2-
patreon: emigre680

.github/ISSUE_TEMPLATE/bug_report.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Bug report
33
about: Create a report to help us improve
4-
title: "[BUG Report] XXX"
4+
title: "[BUG Report] "
55
labels: bug
66
assignees: ''
77

@@ -20,4 +20,4 @@ Steps to reproduce the bug.
2020
Expected behavior.
2121

2222
## Additional details**
23-
Any other useful data to share.
23+
Any other useful data to share.

.github/ISSUE_TEMPLATE/issue.md

-23
This file was deleted.

.github/workflows/multi_ver_unittest.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111
runs-on: ubuntu-latest
1212
strategy:
1313
matrix:
14-
go-version: ["1.19", "1.22"]
14+
go-version: ["1.20", "1.22"]
1515
steps:
1616
- uses: actions/checkout@v4
1717
- name: Setup Go ${{ matrix.go-version }}

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@
1515
# vendor/
1616
gup
1717
dist
18-
cover.html
18+
cover.*

AUTHORS.md

-4
This file was deleted.

CHANGELOG.md

+271
Large diffs are not rendered by default.

CODE_OF_CONDUCT.md

+1-128
Original file line numberDiff line numberDiff line change
@@ -1,128 +1 @@
1-
# Contributor Covenant Code of Conduct
2-
3-
## Our Pledge
4-
5-
We as members, contributors, and leaders pledge to make participation in our
6-
community a harassment-free experience for everyone, regardless of age, body
7-
size, visible or invisible disability, ethnicity, sex characteristics, gender
8-
identity and expression, level of experience, education, socio-economic status,
9-
nationality, personal appearance, race, religion, or sexual identity
10-
and orientation.
11-
12-
We pledge to act and interact in ways that contribute to an open, welcoming,
13-
diverse, inclusive, and healthy community.
14-
15-
## Our Standards
16-
17-
Examples of behavior that contributes to a positive environment for our
18-
community include:
19-
20-
* Demonstrating empathy and kindness toward other people
21-
* Being respectful of differing opinions, viewpoints, and experiences
22-
* Giving and gracefully accepting constructive feedback
23-
* Accepting responsibility and apologizing to those affected by our mistakes,
24-
and learning from the experience
25-
* Focusing on what is best not just for us as individuals, but for the
26-
overall community
27-
28-
Examples of unacceptable behavior include:
29-
30-
* The use of sexualized language or imagery, and sexual attention or
31-
advances of any kind
32-
* Trolling, insulting or derogatory comments, and personal or political attacks
33-
* Public or private harassment
34-
* Publishing others' private information, such as a physical or email
35-
address, without their explicit permission
36-
* Other conduct which could reasonably be considered inappropriate in a
37-
professional setting
38-
39-
## Enforcement Responsibilities
40-
41-
Community leaders are responsible for clarifying and enforcing our standards of
42-
acceptable behavior and will take appropriate and fair corrective action in
43-
response to any behavior that they deem inappropriate, threatening, offensive,
44-
or harmful.
45-
46-
Community leaders have the right and responsibility to remove, edit, or reject
47-
comments, commits, code, wiki edits, issues, and other contributions that are
48-
not aligned to this Code of Conduct, and will communicate reasons for moderation
49-
decisions when appropriate.
50-
51-
## Scope
52-
53-
This Code of Conduct applies within all community spaces, and also applies when
54-
an individual is officially representing the community in public spaces.
55-
Examples of representing our community include using an official e-mail address,
56-
posting via an official social media account, or acting as an appointed
57-
representative at an online or offline event.
58-
59-
## Enforcement
60-
61-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62-
reported to the community leaders responsible for enforcement at
63-
GitHub Issue.
64-
All complaints will be reviewed and investigated promptly and fairly.
65-
66-
All community leaders are obligated to respect the privacy and security of the
67-
reporter of any incident.
68-
69-
## Enforcement Guidelines
70-
71-
Community leaders will follow these Community Impact Guidelines in determining
72-
the consequences for any action they deem in violation of this Code of Conduct:
73-
74-
### 1. Correction
75-
76-
**Community Impact**: Use of inappropriate language or other behavior deemed
77-
unprofessional or unwelcome in the community.
78-
79-
**Consequence**: A private, written warning from community leaders, providing
80-
clarity around the nature of the violation and an explanation of why the
81-
behavior was inappropriate. A public apology may be requested.
82-
83-
### 2. Warning
84-
85-
**Community Impact**: A violation through a single incident or series
86-
of actions.
87-
88-
**Consequence**: A warning with consequences for continued behavior. No
89-
interaction with the people involved, including unsolicited interaction with
90-
those enforcing the Code of Conduct, for a specified period of time. This
91-
includes avoiding interactions in community spaces as well as external channels
92-
like social media. Violating these terms may lead to a temporary or
93-
permanent ban.
94-
95-
### 3. Temporary Ban
96-
97-
**Community Impact**: A serious violation of community standards, including
98-
sustained inappropriate behavior.
99-
100-
**Consequence**: A temporary ban from any sort of interaction or public
101-
communication with the community for a specified period of time. No public or
102-
private interaction with the people involved, including unsolicited interaction
103-
with those enforcing the Code of Conduct, is allowed during this period.
104-
Violating these terms may lead to a permanent ban.
105-
106-
### 4. Permanent Ban
107-
108-
**Community Impact**: Demonstrating a pattern of violation of community
109-
standards, including sustained inappropriate behavior, harassment of an
110-
individual, or aggression toward or disparagement of classes of individuals.
111-
112-
**Consequence**: A permanent ban from any sort of public interaction within
113-
the community.
114-
115-
## Attribution
116-
117-
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118-
version 2.0, available at
119-
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120-
121-
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122-
enforcement ladder](https://github.com/mozilla/diversity).
123-
124-
[homepage]: https://www.contributor-covenant.org
125-
126-
For answers to common questions about this code of conduct, see the FAQ at
127-
https://www.contributor-covenant.org/faq. Translations are available at
128-
https://www.contributor-covenant.org/translations.
1+
Please approach others with respect. That is everything.

CONTRIBUTING.md

+9-139
Original file line numberDiff line numberDiff line change
@@ -1,141 +1,11 @@
1-
<!-- omit in toc -->
1+
## Contributing as a Developer
2+
- When creating a bug report: Please follow the template and provide detailed information.
3+
- When fixing a feature: Create a Pull Request (PR) with accompanying test code.
4+
- When adding a feature: First, propose the feature in an Issue.
25

3-
# Contributing to gup
6+
## Contributing Outside of Coding
7+
The following actions help boost my motivation:
48

5-
First off, thanks for taking the time to contribute! ❤️
6-
7-
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
8-
9-
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
10-
>
11-
> - Star the project
12-
> - Tweet about it
13-
> - Refer this project in your project's readme
14-
> - Mention the project at local meetups and tell your friends/colleagues
15-
16-
<!-- omit in toc -->
17-
18-
## Table of Contents
19-
20-
- [Contributing to gup](#contributing-to-gup)
21-
- [Table of Contents](#table-of-contents)
22-
- [I Have a Question](#i-have-a-question)
23-
- [I Want To Contribute](#i-want-to-contribute)
24-
- [Reporting Bugs](#reporting-bugs)
25-
- [Before Submitting a Bug Report](#before-submitting-a-bug-report)
26-
- [How Do I Submit a Good Bug Report?](#how-do-i-submit-a-good-bug-report)
27-
- [Suggesting Enhancements](#suggesting-enhancements)
28-
- [Before Submitting an Enhancement](#before-submitting-an-enhancement)
29-
- [How Do I Submit a Good Enhancement Suggestion?](#how-do-i-submit-a-good-enhancement-suggestion)
30-
- [Attribution](#attribution)
31-
32-
33-
34-
## I Have a Question
35-
36-
> If you want to ask a question, we assume that you have read the available [Documentation](https://github.com/nao1215/gup/blob/main/README.md).
37-
38-
Before you ask a question, it is best to search for existing [Issues](https://github.com/nao1215/gup/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
39-
40-
If you then still feel the need to ask a question and need clarification, we recommend the following:
41-
42-
- Open an [Issue](https://github.com/nao1215/gup/issues/new).
43-
- Provide as much context as you can about what you're running into.
44-
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
45-
46-
We will then take care of the issue as soon as possible.
47-
48-
<!--
49-
You might want to create a separate issue tag for questions and include it in this description. People should then tag their issues accordingly.
50-
51-
Depending on how large the project is, you may want to outsource the questioning, e.g. to Stack Overflow or Gitter. You may add additional contact and information possibilities:
52-
53-
- IRC
54-
- Slack
55-
- Gitter
56-
- Stack Overflow tag
57-
- Blog
58-
- FAQ
59-
- Roadmap
60-
- E-Mail List
61-
- Forum
62-
-->
63-
64-
## I Want To Contribute
65-
66-
> ### Legal Notice <!-- omit in toc -->
67-
>
68-
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
69-
70-
### Reporting Bugs
71-
72-
<!-- omit in toc -->
73-
74-
#### Before Submitting a Bug Report
75-
76-
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
77-
78-
- Make sure that you are using the latest version.
79-
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://github.com/nao1215/gup/blob/main/README.md). If you are looking for support, you might want to check [this section](#i-have-a-question)).
80-
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/nao1215/gupissues?q=label%3Abug).
81-
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
82-
- Collect information about the bug:
83-
- Stack trace (Traceback)
84-
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
85-
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
86-
- Possibly your input and the output
87-
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
88-
89-
<!-- omit in toc -->
90-
91-
#### How Do I Submit a Good Bug Report?
92-
93-
> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <[email protected]>.
94-
> <!-- You may add a PGP key to allow the messages to be sent encrypted as well. -->
95-
96-
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
97-
98-
- Open an [Issue](https://github.com/nao1215/gup/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
99-
- Explain the behavior you would expect and the actual behavior.
100-
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
101-
- Provide the information you collected in the previous section.
102-
103-
Once it's filed:
104-
105-
- The project team will label the issue accordingly.
106-
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
107-
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
108-
109-
<!-- You might want to create an issue template for bugs and errors that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
110-
111-
112-
### Suggesting Enhancements
113-
114-
This section guides you through submitting an enhancement suggestion for gup, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
115-
116-
<!-- omit in toc -->
117-
118-
#### Before Submitting an Enhancement
119-
120-
- Make sure that you are using the latest version.
121-
- Read the [documentation](https://github.com/nao1215/gup/blob/main/README.md) carefully and find out if the functionality is already covered, maybe by an individual configuration.
122-
- Perform a [search](https://github.com/nao1215/gup/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
123-
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
124-
125-
<!-- omit in toc -->
126-
127-
#### How Do I Submit a Good Enhancement Suggestion?
128-
129-
Enhancement suggestions are tracked as [GitHub issues](https://github.com/nao1215/gup/issues).
130-
131-
- Use a **clear and descriptive title** for the issue to identify the suggestion.
132-
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
133-
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
134-
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. <!-- this should only be included if the project has a GUI -->
135-
- **Explain why this enhancement would be useful** to most gup users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
136-
137-
<!-- You might want to create an issue template for enhancement suggestions that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
138-
139-
## Attribution
140-
141-
This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!
9+
- Giving a GitHub Star
10+
- Promoting the application
11+
- Becoming a GitHub Sponsor

0 commit comments

Comments
 (0)