Skip to content

Commit

Permalink
Update resources
Browse files Browse the repository at this point in the history
  • Loading branch information
hugoalh committed Dec 27, 2023
1 parent e4f55b0 commit 77ee342
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 54 deletions.
1 change: 0 additions & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,3 @@ updates:
open-pull-requests-limit: 100
pull-request-branch-name:
separator: "/"
rebase-strategy: "disabled"
52 changes: 3 additions & 49 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,7 @@
# Contributing Guide

This Contributing Guide includes the guidelines, methods, and ways to contribute on different categories, items, and types; If this Contributing Guide does not include some of the categories, items, and/or types, maybe:
This Contributing Guide is depend on ["hxhS (hugoalh & hugoalh Studio) Universal Contributing Guide"](https://github.com/hugoalh/hugoalh/blob/main/universal-guide/contributing.md), along with revise and take precedence over it.

- those guidelines, methods, and/or ways are separated from this Contributing Guide and exist and/or store in their corresponding places,
- those categories, items, and/or types are easy to understand how to correctly contributing, or
- the maintainers and/or owners forgot to edit this Contributing Guide.
## Revise

If you have any questions and/or still confused, try to create a discussion.

## Codes

All of the codes in this project and repository are follow the [hxhS (hugoalh & hugoalh Studio) Coding Guide](https://github.com/hugoalh/hugoalh/blob/main/guide/code/main.md).

## Deploys & Versions

These are always the works of the maintainers and/or owners, which are follow the [hxhS (hugoalh & hugoalh Studio) Versioning Guide](https://github.com/hugoalh/hugoalh/blob/main/guide/version/main.md).

## Discussions

- Before create a discussion, check whether any similar discussions are already exist.
- Any reports and requests should create an issue instead.

## Documentations, Documents & Wiki

To improve the documentations and/or documents, you can:

- clone this repository, edit the documentations and/or documents, and create a pull request, or
- create an issue.

To improve the wiki, create an issue.

## I18ns (Internationalizations) & Translations

This project and repository does not need to do i18ns and/or translations.

If you want to do i18ns and/or translations on the documentations, documents and/or wiki, please see the section "[Documentations, Documents & Wiki](#documentations-documents--wiki)".

## Issues

- Before create an issue, check whether any similar issues are already exist.
- Any questions should create a discussion instead.
- For any security vulnerability reports, please visit the Security Policy (file: `SECURITY.md`).

## Pull Requests

- Before create a pull request, check whether any similar pull requests are already exist.
- Always create a pull request to the default branch (mostly named `main` or `master`) of this repository.
- Try to avoid merge conflicts if possible.
- Try to avoid a pull request with too many changes if possible.
- A large pull request not only stretches the review time, but also makes it much harder to spot issues.
- It is better to split the pull request to multiple smaller ones.
- If your pull request is not ready but want to save it first, you can submit it by mark as draft, and no need to add any identifications to the title (e.g.: `[WIP] XXXXXXXX`).
*N/A*
6 changes: 2 additions & 4 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@
> - Values in italic format are subject to change.
> - Versions which not in the list are also end of life.
## Report Vulnerability
## Report A Vulnerability

If you believe you have found any security vulnerability, please report it via the [Security Advisories system](https://github.com/hugoalh/disk-space-optimizer-ghaction/security/advisories/new) instead of create an issue and/or report it publicly.

All new reports may need `~48 hours (~2 days)` to begin the process.
You can report a security vulnerability by [create a security vulnerability report](https://github.com/hugoalh/hugoalh/blob/main/universal-guide/contributing.md#create-a-security-vulnerability-report).

0 comments on commit 77ee342

Please sign in to comment.