-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(docs): update readme and github templates
- Loading branch information
Showing
6 changed files
with
285 additions
and
74 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**System and Environment** | ||
The version and configuration of Hexo and Icarus. | ||
|
||
- Hexo, OS, and node version (use `hexo version` command) | ||
- Site configuration file `_config.yml` | ||
- Theme configuration file `themes/icarus/_config.yml` | ||
- Any additional theme configuration files (post front-matter, `_config.post.yml`, or `_config.page.yml`) | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Desktop (please complete the following information if applicable):** | ||
- OS: [e.g. iOS] | ||
- Browser [e.g. chrome, safari] | ||
- Version [e.g. 22] | ||
|
||
**Smartphone (please complete the following information if applicable):** | ||
- Device: [e.g. iPhone6] | ||
- OS: [e.g. iOS8.1] | ||
- Browser [e.g. stock browser, safari] | ||
- Version [e.g. 22] | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
|
||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
|
||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
|
||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
|
||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
name: Pull request | ||
about: Suggest a code change to this project | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Note 0** | ||
Please review [the contributing guide](https://github.com/ppoffice/hexo-theme-icarus/blob/master/CONTRIBUTING.md) before making this pull request. | ||
|
||
**Note 1** | ||
|
||
Please break up your pull request into multiple smaller requests if it contains multiple bug fixes | ||
or new features. | ||
Each pull request should have one bug fix or new feature only for better code maintainability. | ||
|
||
**Note 2** | ||
|
||
Many components of this theme, including core functions, some Hexo extensions, widgets and plugins, | ||
have been moved to [ppoffice/hexo-component-inferno](https://github.com/ppoffice/hexo-component-inferno). | ||
Please make a pull request to that repository instead of this one if your changes are related to | ||
the above components. | ||
|
||
**Detailed description** | ||
|
||
> Please use the [Icarus issue template](https://github.com/ppoffice/hexo-theme-icarus/blob/master/.github/ISSUE_TEMPLATE/bug_report.md) if it is a bug fix. | ||
> Please use the [Icarus feature request template](https://github.com/ppoffice/hexo-theme-icarus/blob/master/.github/ISSUE_TEMPLATE/feature_request.md) if it is a bug fix. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Contributing Guidelines | ||
|
||
## Code styles | ||
|
||
Please refer to the [.eslintrc.json](https://github.com/ppoffice/hexo-theme-icarus/blob/master/.eslintrc.json). | ||
You can also use `npm run lint` or `yarn lint` to fix code style issues. | ||
|
||
## Project versioning | ||
|
||
We use [SemVer](http://semver.org/) for versioning. | ||
Any changes to the code base should not be released using an existing version. | ||
|
||
## Commit message format | ||
|
||
The commit message should follow the [Bluejava commit message format](https://github.com/bluejava/git-commit-guide). | ||
The supported scopes are: | ||
|
||
- **core** for changes related to Hexo extensions and Icarus-specific functions | ||
- **comment** for comment plugin layout, schema, style, or script changes | ||
- **share** for share plugin layout, schema, style, or script changes | ||
- **donate** for donation plugin layout, schema, style, or script changes | ||
- **search** for search plugin layout, schema, style, or script changes | ||
- **widget** for widget layout, schema, style, or script changes | ||
- **plugin** for other plugin layout, schema, style, or script changes | ||
- **i18n** for adding or updating translations | ||
- **test** for testing or linting-related commits | ||
- **build** for build scripts, CI, other development or deployment related commits | ||
- use __\*__ or leave empty to refer to commits that do not have a clear scope | ||
|
||
## Submit changes | ||
|
||
1. Fork this repository, make changes to it, and run it against some actual Hexo sites to see if | ||
anything is broken. | ||
You should also run `npm run lint` or `yarn lint` to find and fix any code formatting issue. | ||
2. Submit a pull request to our repository. Please make sure you followed the instructions | ||
above. | ||
3. We will review the pull request regularly and inform you of our questions and any changes | ||
that need to be made before we can merge your pull request. | ||
4. We expect your response within two weeks, after which your pull request may be closed if | ||
no activity is shown. |
Oops, something went wrong.