Skip to content

Commit

Permalink
Merge branch 'main' into docs-readme-nodejs
Browse files Browse the repository at this point in the history
  • Loading branch information
5ouma authored Oct 13, 2024
2 parents 91e9f5e + b0b84ca commit 148967f
Show file tree
Hide file tree
Showing 6 changed files with 44 additions and 46 deletions.
36 changes: 18 additions & 18 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
nationality, personal appearance, race, religion, or sexual identity and
orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
Expand All @@ -22,17 +22,17 @@ community include:
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the
overall community
- Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or
advances of any kind
- The use of sexualized language or imagery, and sexual attention or advances of
any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email
address, without their explicit permission
- Publishing others' private information, such as a physical or email address,
without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

Expand All @@ -59,9 +59,8 @@ representative at an online or offline event.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
any ways @5ouma have.
All complaints will be reviewed and investigated promptly and fairly.
reported to the community leaders responsible for enforcement at any ways @5ouma
have. All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
Expand All @@ -82,15 +81,15 @@ behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.
**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

Expand All @@ -109,16 +108,17 @@ Violating these terms may lead to a permanent ban.
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.
**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).

Community Impact Guidelines were inspired by [Mozilla's code of conduct
Community Impact Guidelines were inspired by
[Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org
Expand Down
16 changes: 7 additions & 9 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,8 @@
> [!NOTE]
> You must follow the [Code of Conduct](./CODE_OF_CONDUCT.md).
I happily welcome your contributions!
Before you contribute,
I would recommend reading this guideline for a better development experience.
I happily welcome your contributions! Before you contribute, I would recommend
reading this guideline for a better development experience.

<br />

Expand All @@ -31,14 +30,13 @@ Body

## ❓ Pull Requests Title

You don't need to add any prefixes like `feature` or `bug fix`
to the Pull Requests title.
I can recognize what kind of PR it is from labels.
Please give a clear title.
You don't need to add any prefixes like `feature` or `bug fix` to the Pull
Requests title. I can recognize what kind of PR it is from labels. Please give a
clear title.

<br />

## 🪵 Commit Log

I do squash merge to the main branch to keep the commit history clean.
When merging your Pull Request, I'll add the Conventional Commits type and scope.
I do squash merge to the main branch to keep the commit history clean. When
merging your Pull Request, I'll add the Conventional Commits type and scope.
3 changes: 2 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,5 @@ A clear and concise description

<br />

- [ ] I agree to follow the [Code of Conduct](https://github.com/5ouma/reproxy/blob/main/.github/CODE_OF_CONDUCT.md).
- [ ] I agree to follow the
[Code of Conduct](https://github.com/5ouma/reproxy/blob/main/.github/CODE_OF_CONDUCT.md).
3 changes: 2 additions & 1 deletion .github/SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

## 🛡️ Reporting a Vulnerability

If you find any issues of security, please report on [Security Advisories](https://github.com/5ouma/reproxy/security/advisories/new).
If you find any issues of security, please report on
[Security Advisories](https://github.com/5ouma/reproxy/security/advisories/new).

> [!CAUTION]
> Please do NOT open Issues.
25 changes: 12 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,16 @@

## 💡 Concepts

You can host your specific file on the GitHub repository.
The usage I assume is for one-line scripts.
(i.e. dotfiles or some install scripts, like `curl https://example.com | sh`)
You can host your specific file on the GitHub repository. The usage I assume is
for one-line scripts. (i.e. dotfiles or some install scripts, like
`curl https://example.com | sh`)

If you access from browsers, you'll redirected to the GitHub page, not a raw file.
If you access from browsers, you'll redirected to the GitHub page, not a raw
file.

For the development or testing, you can access to the different branches or tags.
To do this, simply add the ref name to the sub-directory.
(i.e. `curl https://example.com/ref | sh`)
For the development or testing, you can access to the different branches or
tags. To do this, simply add the ref name to the sub-directory. (i.e.
`curl https://example.com/ref | sh`)

<br /><br />

Expand Down Expand Up @@ -99,8 +100,7 @@ To do this, simply add the ref name to the sub-directory.
export { default } from "jsr:@5ouma/reproxy";
```
3. Set the environment variables
(_Don't forget!!_)
3. Set the environment variables (_Don't forget!!_)
> [🌍 Environment Variables](#-environment-variables)
Expand Down Expand Up @@ -186,7 +186,6 @@ To do this, simply add the ref name to the sub-directory.
## 🎽 Contributing
I happily welcome your contributions!
Before you contribute,
I would recommend reading [CONTRIBUTING.md](./.github/CONTRIBUTING.md)
for a better development experience.
I happily welcome your contributions! Before you contribute, I would recommend
reading [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for a better development
experience.
7 changes: 3 additions & 4 deletions deno.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,10 @@
"include": ["LICENSE", "README.md", "deno.json", "src/"],
"exclude": ["**/*.test.ts", "src/libs/test_utils.ts"]
},
"fmt": { "exclude": ["LICENSE", "README.md", ".github/**/*.md"] },
"tasks": {
"run": "deno run --env-file='.env' -EN='api.github.com'",
"start": "deno task run src/server.ts",
"dev": "deno task run --watch src/server.ts",
"serve": "deno serve --env-file='.env' -EN='api.github.com'",
"start": "deno task serve src/server.ts",
"dev": "deno task serve --watch src/server.ts",
"test": "deno test --doc -EN='api.github.com' --parallel --shuffle",
"cov": "deno task test --coverage && deno coverage --lcov > coverage.lcov"
},
Expand Down

0 comments on commit 148967f

Please sign in to comment.