Skip to content
This repository was archived by the owner on Jan 12, 2024. It is now read-only.

Commit 618bd3e

Browse files
committed
chore: spotless apply, workflows!
1 parent f467559 commit 618bd3e

4 files changed

Lines changed: 162 additions & 0 deletions

File tree

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @auguwu

.github/CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at cutie@floofy.dev. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

.github/CONTRIBUTING.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Contributing to noel-commons
2+
We gladly accept contributions, and we truly thank whoever supports this project!
3+
4+
## Code of Conduct
5+
Check out our [Code of Conduct](./CODE_OF_CONDUCT.md).
6+
7+
By contributing, we expect you to uphold this conduct.
8+
9+
## Ways to Contribute
10+
### Bug Reporting
11+
Before submitting an issue make sure the issue hasn't been reported yet.
12+
13+
Please consider these following guidelines when contributing:
14+
* Be clear and concise with the title, it will help others link their issues and solutions to yours.
15+
* Specify the ways to reproduce the bug, so our development team and contributors can reproduce by themselves.
16+
* Show the output, using logs and screenshots, to help others understand your issue.
17+
* For any uncertainty of how to reproduce the issue, specify that as well! Describe your actions before the bug occurred.
18+
19+
### Submitting Enhancements
20+
We appreciate new ideas and improvements, and we want Nino to reach its full potential!
21+
If you have any enhancement you want done in Nino please submit an issue!
22+
23+
Before submitting the issue, consider the following guidelines:
24+
* Be clear and concise with the title, it will help others link their issues and solutions to yours.
25+
* In the enhancement's description, please add a way to implement the idea.
26+
It doesn't have to be in code but rather an idea to make sure it's up to standards
27+
* Add examples of how the feature can be interacted with, it will make the general concept much easier to grasp.
28+
29+
### Pull Requests
30+
Before submitting a PR please make sure there is no other similar PR submitted.
31+
32+
Do not submit a PR that adds any enhancements before the enhancement issue was approved, or else it will be ignored.
33+
34+
If your PR regards any issues please link the issue to the PR.

.github/workflows/ktlint.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Build / Linting errors
2+
on:
3+
pull_request:
4+
push:
5+
branches:
6+
- 'feature/**'
7+
- 'issue/gh-**'
8+
- trunk
9+
- master
10+
paths-ignore:
11+
- '.github/**'
12+
- 'assets/'
13+
- .dockerignore
14+
- gradle.properties
15+
- '**.md'
16+
- LICENSE
17+
- renovate.json
18+
- settings.gradle.kts
19+
jobs:
20+
ktlint:
21+
runs-on: ubuntu-latest
22+
strategy:
23+
matrix:
24+
java-version: [16, 17]
25+
26+
steps:
27+
- name: Checks out the repository
28+
uses: actions/checkout@v2
29+
30+
- name: Sets up Java v${{ matrix.java-version }}
31+
uses: actions/setup-java@v2
32+
with:
33+
distribution: adopt # AdoptOpenJDK is <3
34+
java-version: ${{ matrix.java-version }}
35+
36+
- name: Setup Gradle cache
37+
uses: actions/cache@v2.1.6
38+
with:
39+
path: ~/.gradle/caches
40+
key: ${{ runner.os }}-test-gradle-${{ hashFiles('**/*.gradle*') }}
41+
restore-keys: |
42+
${{ runner.os }}-test-gradle-
43+
44+
- name: Lets ./gradlew be executable
45+
run: chmod +x ./gradlew
46+
47+
- name: Lints the repository for any code errors
48+
run: ./gradlew spotlessCheck
49+
50+
- name: Builds the project for any errors
51+
run: ./gradlew compileKotlin

0 commit comments

Comments
 (0)