Skip to content

Commit f3fcb8c

Browse files
soimkimsoimkim
authored
Add github action related files
2 parents 2a541e5 + 24ea9e1 commit f3fcb8c

File tree

8 files changed

+306
-0
lines changed

8 files changed

+306
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: soimkim
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
16+
**Expected behavior**
17+
A clear and concise description of what you expected to happen.
18+
19+
**System environment (please complete the following information):**
20+
- OS: [e.g. Ubuntu 16.04, Windows, Mac OS]
21+
- Python : [e.g. python3.7]
22+
23+
**Additional context**
24+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: soimkim
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## Description
2+
(Please describe what this PR do.)
3+
4+
5+
## Type of change
6+
Please insert 'x' one of the type of change.
7+
- [ ] Bug fix (non-breaking change which fixes an issue)
8+
- [ ] New feature (non-breaking change which adds functionality)
9+
- [ ] Documentation update
10+
- [ ] Refactoring, Maintenance
11+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
12+

‎.github/release-drafter-config.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name-template: 'v$RESOLVED_VERSION'
2+
tag-template: 'v$RESOLVED_VERSION'
3+
categories:
4+
- title: '🚀 Features'
5+
label: 'enhancement'
6+
- title: '🐛 Hotfixes'
7+
labels:
8+
- 'bug'
9+
- 'bug fix'
10+
- title: '🔧 Maintenance'
11+
labels:
12+
- 'documentation'
13+
- 'chore'
14+
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
15+
version-resolver:
16+
major:
17+
labels:
18+
- 'major'
19+
minor:
20+
labels:
21+
- 'minor'
22+
patch:
23+
labels:
24+
- 'patch'
25+
default: patch
26+
template: |
27+
## Changes
28+
$CHANGES

‎.github/workflows/publish-release.yml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# 1. Update changelog
2+
# 2. Upload a Python Package using Twine
3+
4+
name: Release fosslight_reuse
5+
6+
on:
7+
release:
8+
types: [published]
9+
10+
jobs:
11+
update-changelog:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v2
15+
- name: update changelog with gren
16+
env:
17+
GREN_GITHUB_TOKEN: ${{ secrets.TOKEN }}
18+
run: |
19+
npm install [email protected]
20+
node_modules/.bin/gren changelog --override
21+
- name: Commit files
22+
run: |
23+
git config --local user.name "github-actions[bot]"
24+
git add CHANGELOG.md
25+
git commit -m "Update ChangeLog"
26+
- name: Push changes
27+
uses: ad-m/github-push-action@master
28+
with:
29+
github_token: ${{ secrets.TOKEN }}
30+
branch: main
31+
32+
deploy:
33+
runs-on: ubuntu-18.04
34+
needs: update-changelog
35+
steps:
36+
- uses: actions/checkout@v2
37+
- name: Set up Python
38+
uses: actions/setup-python@v2
39+
with:
40+
python-version: '3.7'
41+
- name: Install dependencies
42+
run: |
43+
python -m pip install --upgrade pip
44+
pip install setuptools wheel twine
45+
- name: Build and publish
46+
env:
47+
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
48+
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
49+
run: |
50+
python setup.py sdist bdist_wheel
51+
twine upload dist/*

‎.github/workflows/release-drafter-config.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: Release Drafter
2+
on:
3+
push:
4+
branches:
5+
- main
6+
jobs:
7+
update_release_draft:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: release-drafter/release-drafter@v5
11+
with:
12+
config-name: release-drafter-config.yml
13+
env:
14+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎CODE_OF_CONDUCT.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
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+
[email protected].
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.

‎CONTRIBUTING.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## Contributing
2+
3+
Hi! I'm really appreciate that you'd like to contribute to this project. Your help is essential for keeping it great.
4+
5+
## Submitting a pull request
6+
7+
1. <a class="github-button" href="https://github.com/fosslight/fosslight_reuse/fork" data-icon="octicon-repo-forked" aria-label="Fork fosslight/fosslight_reuse on GitHub">```Fork```</a> and clone the repository
8+
2. Create a new branch: `git checkout -b my-branch-name`
9+
3. Make your change and make sure it works properly.
10+
4. Push to your fork and submit a pull request.
11+
5. When you write to PR template, you can add labels based on your type of changes.
12+
- ![bug fix](https://img.shields.io/badge/-bug%20fix-B60205) : Bug fix
13+
- ![enhancement](https://img.shields.io/badge/-enhancement-1D76DB) : New feature
14+
- ![documentation](https://img.shields.io/badge/-documentation-0E8A16) : Documentation update
15+
- ![chore](https://img.shields.io/badge/-chore-0E8A16) : Refactoring, Maintenance
16+
6. Please wait for your pull request to be reviewed and merged!
17+
18+
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
19+
20+
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
21+
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
22+
23+
Work in Progress pull request are also welcome to get feedback early on, or if there is something blocked you.
24+
25+
## Resources
26+
27+
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
28+
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
29+
- [GitHub Help](https://help.github.com)

0 commit comments

Comments
 (0)