Skip to content

Commit

Permalink
chore(dotfiles): ci and document updates
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastienrousseau committed Apr 27, 2023
1 parent a5d1f19 commit 23f820a
Show file tree
Hide file tree
Showing 5 changed files with 130 additions and 112 deletions.
109 changes: 62 additions & 47 deletions .github/CODE-OF-CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,31 @@
# Contributor Covenant Code of Conduct
<!-- markdownlint-disable MD033 MD041 -->

[![Banner representing the Dotfiles Library][logo]][website]
<img src="https://kura.pro/dotfiles/v2/images/logos/dotfiles.svg"
alt="dotfiles logo" width="261" align="right" />

## Our Pledge
<!-- markdownlint-enable MD033 MD041 -->

# Dotfiles (v0.2.465)

Simply designed to fit your shell life 🐚

![Dotfiles banner][banner]

## Contributor Covenant Code of Conduct

### Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of
experience, nationality, personal appearance, race, religion, or sexual identity
and orientation.
contributors and maintainers pledge to making participation in our
project and our community a harassment-free experience for everyone,
regardless of age, body size, disability, ethnicity, gender identity and
expression, level of experience, nationality, personal appearance, race,
religion, or sexual identity and orientation.

## Our Standards
### Our Standards

Examples of behaviour that contributes to creating a positive environment
include:
Examples of behaviour that contributes to creating a positive
environment include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
Expand All @@ -24,55 +35,59 @@ include:

Examples of unacceptable behaviour by participants include:

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

## Our Responsibilities
### Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behaviour and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behaviour.
Project maintainers are responsible for clarifying the standards of
acceptable behaviour and are expected to take appropriate and fair
corrective action in response to any instances of unacceptable
behaviour.

Project maintainers have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, or to ban temporarily or permanently any
contributor for other behaviours that they deem inappropriate, threatening,
offensive, or harmful.
Project maintainers have the right and responsibility to remove, edit,
or reject comments, commits, code, wiki edits, issues, and other
contributions that are not aligned to this Code of Conduct, or to ban
temporarily or permanently any contributor for other behaviours that
they deem inappropriate, threatening, offensive, or harmful.

## Scope
### Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
This Code of Conduct applies both within project spaces and in public
spaces when an individual is representing the project or its community.
Examples of representing a project or community include using an
official project e-mail address, posting via an official social media
account, or acting as an appointed representative at an online or
offline event. Representation of a project may be further defined and
clarified by project maintainers.

## Enforcement
### Enforcement

Instances of abusive, harassing, or otherwise unacceptable behaviour may be
reported by contacting the project team. The project team will review and
investigate all complaints, and will respond in a way that it deems appropriate
to the circumstances. The project team is obligated to maintain confidentiality
with regard to the reporter of an incident. Further details of specific
enforcement policies may be posted separately.
Instances of abusive, harassing, or otherwise unacceptable behaviour may
be reported by contacting the project team. The project team will
review and investigate all complaints, and will respond in a way that it
deems appropriate to the circumstances. The project team is obligated to
maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted
separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
Project maintainers who do not follow or enforce the Code of Conduct in
good faith may face temporary or permanent repercussions as determined
by other members of the project's leadership.

## Attribution
### Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
This Code of Conduct is adapted from the
[Contributor Covenant][homepage], version 1.4, available at
[http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
[logo]: https://github.com/sebastienrousseau/dotfiles/raw/master/assets/dotfiles.svg
[website]: https://dotfiles.io
[banner]: https://kura.pro/dotfiles/v2/images/titles/title-dotfiles.svg
70 changes: 42 additions & 28 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,64 @@
# Contributing to Dotfiles
<!-- markdownlint-disable MD033 MD041 -->

[![Banner representing the Dotfiles Library][logo]][website]
<img src="https://kura.pro/dotfiles/v2/images/logos/dotfiles.svg"
alt="dotfiles logo" width="261" align="right" />

Thank you so much for wanting to contribute to Dotfiles! There are a couple ways
to help out.
<!-- markdownlint-enable MD033 MD041 -->

# Dotfiles (v0.2.465)

Simply designed to fit your shell life 🐚

![Dotfiles banner][banner]

## Contributing to Dotfiles

Thank you so much for wanting to contribute to Dotfiles! There are a
couple ways to help out.

## Evangelize

Just tell people about Dotfiles. We believe that a bigger, more involved
community makes for a better product, and that better products make the world a
better place. We can always use more feedback and learn from you.
community makes for a better product, and that better products make the
world a better place. We can always use more feedback and learn from you.

## How to Contribute

Please find down here, our guides for submitting issues and pull requests.
Please find down here, our guides for submitting issues and pull
requests.

### Bug Reports

If you encounter a bug that hasn't already been filled, please file a bug
report. Let us know of things we should fix, things we should add, questions,
etc.
If you encounter a bug that hasn't already been filled, please file a
bug report. Let us know of things we should fix, things we should add,
questions, etc.

Warning us of a bug is possibly the single most valuable contribution you can
make to Dotfiles.
Warning us of a bug is possibly the single most valuable contribution
you can make to Dotfiles.

- Head [here](https://github.com/reedia/dotfiles/issues/new) to submit a new
issue.
- Head [here](https://github.com/reedia/dotfiles/issues/new) to submit
a new issue.
- Include a descriptive title that is straight to the point.
- Write a detailed description on what the issue is all about.
- Wait for someone to get to the issue and add labels.
- The issue will be fixed soon!

### Code Contributions

Contributing code is one of the more difficult ways to contribute to Dotfiles.
Contributing code is one of the more difficult ways to contribute to
Dotfiles.

#### Feature Requests

Filling feature requests is one of the most popular ways to contribute to
Dotfiles.
Filling feature requests is one of the most popular ways to contribute
to Dotfiles.

Is there some feature request that you'd like to code up yourself? Is there a
feature you asked for yourself that you'd like to code?
Is there some feature request that you'd like to code up yourself? Is
there a feature you asked for yourself that you'd like to code?

Here's how to contribute code for a new feature to Dotfiles. Pull Requests
allow you to share your own code with us, and we can merge it into the main
repo.
Here's how to contribute code for a new feature to Dotfiles. Pull
requests allow you to share your own code with us, and we can merge it
into the main repo.

#### Adding Code

Expand All @@ -55,13 +68,14 @@ repo.

#### Fixing an Issue

Have you found a solution to an issue? Here is how you can submit your code to
Dotfiles.
Have you found a solution to an issue? Here is how you can submit your
code to Dotfiles.

- Fork the repo, and refer above for how to change up code.
- Head to your local fork of the repo, and click the "New Pull Request" button.
- Head to your local fork of the repo, and click the "New Pull Request"
button.
- Include a title that is straight to the point.
- Wait for someone to review the pull request, and then merge your pull request!
- Wait for someone to review the pull request, and then merge your pull
request!

[logo]: https://github.com/sebastienrousseau/dotfiles/raw/master/assets/dotfiles.svg
[website]: https://dotfiles.io
[banner]: https://kura.pro/dotfiles/v2/images/titles/title-dotfiles.svg
33 changes: 22 additions & 11 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,30 @@
# Security
<!-- markdownlint-disable MD033 MD041 -->

[![Banner representing the Dotfiles Library][logo]][website]
<img src="https://kura.pro/dotfiles/v2/images/logos/dotfiles.svg"
alt="dotfiles logo" width="261" align="right" />

We take the security of our software products and services seriously, which
includes all source code repositories managed through our GitHub repositories.
<!-- markdownlint-enable MD033 MD041 -->

If you believe you have found a security vulnerability in any of our repository,
please report it to us as described below.
# Dotfiles (v0.2.465)

Simply designed to fit your shell life 🐚

![Dotfiles banner][banner]

## Security

We take the security of our software products and services seriously,
which includes all source code repositories managed through our GitHub
repositories.

If you believe you have found a security vulnerability in any of our
repository, please report it to us as described below.

## Reporting Security Issues

Please include the requested information listed below (as much as you can
provide) to help us better understand the nature and scope of the possible
issue:
Please include the requested information listed below (as much as you
can provide) to help us better understand the nature and scope of the
possible issue:

- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting,
etc.)
Expand All @@ -25,5 +37,4 @@ issue:

This information will help us triage your report more quickly.

[logo]: https://github.com/sebastienrousseau/dotfiles/raw/master/assets/dotfiles.svg
[website]: https://dotfiles.io
[banner]: https://kura.pro/dotfiles/v2/images/titles/title-dotfiles.svg
8 changes: 4 additions & 4 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ jobs:
steps:
- run: echo ${{github.ref}}

- uses: actions/checkout@v2
- uses: actions/checkout@v3

- uses: pnpm/[email protected].2
- uses: pnpm/[email protected].4
with:
version: 7

- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2
uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node-version }}
cache: "pnpm"
Expand All @@ -39,7 +39,7 @@ jobs:
steps:
- uses: actions/checkout@v2

- uses: pnpm/[email protected].2
- uses: pnpm/[email protected].4
with:
version: 7

Expand Down
22 changes: 0 additions & 22 deletions .github/workflows/stale.yml

This file was deleted.

0 comments on commit 23f820a

Please sign in to comment.