-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: 📝 Updating the readme and docs
- Loading branch information
Showing
20 changed files
with
1,419 additions
and
20 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
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 @@ | ||
* @Nytuo |
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,13 @@ | ||
# These are supported funding model platforms | ||
|
||
github: [Nytuo] | ||
patreon: # Replace with a single Patreon username | ||
open_collective: # Replace with a single Open Collective username | ||
ko_fi: nytuo | ||
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel | ||
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry | ||
liberapay: # Replace with a single Liberapay username | ||
issuehunt: # Replace with a single IssueHunt username | ||
otechie: # Replace with a single Otechie username | ||
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry | ||
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] |
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,37 @@ | ||
--- | ||
name: Bug Report | ||
about: Create a report to help CosmicComics to improve | ||
title: "bug: " | ||
labels: "bug" | ||
assignees: "" | ||
--- | ||
|
||
# Bug Report | ||
|
||
**CosmicComics version:** | ||
|
||
<!-- Please specify commit or tag version. --> | ||
|
||
**Current behavior:** | ||
|
||
<!-- Describe how the bug manifests. --> | ||
|
||
**Expected behavior:** | ||
|
||
<!-- Describe what you expect the behavior to be without the bug. --> | ||
|
||
**Steps to reproduce:** | ||
|
||
<!-- Explain the steps required to duplicate the issue, especially if you are able to provide a sample application. --> | ||
|
||
**Related code:** | ||
|
||
<!-- If you are able to illustrate the bug or feature request with an example, please provide it here. --> | ||
|
||
``` | ||
insert short code snippets here | ||
``` | ||
|
||
**Other information:** | ||
|
||
<!-- List any other information that is relevant to your issue. Related issues, suggestions on how to fix, Stack Overflow links, forum links, etc. --> |
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,35 @@ | ||
--- | ||
name: Feature Request | ||
about: Suggest an idea for this project | ||
title: "feat: " | ||
labels: "enhancement" | ||
assignees: "" | ||
--- | ||
|
||
# Feature Request | ||
|
||
**Describe the Feature Request** | ||
|
||
<!-- A clear and concise description of what the feature request is. Please include if your feature request is related to a problem. --> | ||
|
||
**Describe Preferred Solution** | ||
|
||
<!-- A clear and concise description of what you want to happen. --> | ||
|
||
**Describe Alternatives** | ||
|
||
<!-- A clear and concise description of any alternative solutions or features you've considered. --> | ||
|
||
**Related Code** | ||
|
||
<!-- If you are able to illustrate the bug or feature request with an example, please provide it here. --> | ||
|
||
**Additional Context** | ||
|
||
<!-- List any other information that is relevant to your issue. Stack traces, related issues, suggestions on how to add, use case, Stack Overflow links, forum links, screenshots, OS if applicable, etc. --> | ||
|
||
**If the feature request is approved, would you be willing to submit a PR?** | ||
_(Help can be provided if you need assistance submitting a PR)_ | ||
|
||
- [ ] Yes | ||
- [ ] No |
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,7 @@ | ||
--- | ||
name: Codebase improvement | ||
about: Provide your feedback for the existing codebase. Suggest a better solution for algorithms, development tools, etc. | ||
title: "dev: " | ||
labels: "enhancement" | ||
assignees: "" | ||
--- |
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,38 @@ | ||
--- | ||
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. | ||
|
||
**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):** | ||
- OS: [e.g. iOS] | ||
- Browser [e.g. chrome, safari] | ||
- Version [e.g. 22] | ||
|
||
**Smartphone (please complete the following information):** | ||
- 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,6 @@ | ||
--- | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: CosmicComics Community Support | ||
url: https://github.com/Nytuo/CosmicComics/discussions | ||
about: Please ask and answer questions 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,20 @@ | ||
--- | ||
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,40 @@ | ||
<!--- Please provide a general summary of your changes in the title above --> | ||
|
||
## Pull Request type | ||
|
||
<!-- Please try to limit your pull request to one type; submit multiple pull requests if needed. --> | ||
|
||
Please check the type of change your PR introduces: | ||
|
||
- [ ] Bugfix | ||
- [ ] Feature | ||
- [ ] Code style update (formatting, renaming) | ||
- [ ] Refactoring (no functional changes, no API changes) | ||
- [ ] Build-related changes | ||
- [ ] Documentation content changes | ||
- [ ] Other (please describe): | ||
|
||
## What is the current behavior? | ||
|
||
<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. --> | ||
|
||
Issue Number: N/A | ||
|
||
## What is the new behavior? | ||
|
||
<!-- Please describe the behavior or changes that are being added by this PR. --> | ||
|
||
- | ||
- | ||
- | ||
|
||
## Does this introduce a breaking change? | ||
|
||
- [ ] Yes | ||
- [ ] No | ||
|
||
<!-- If this does introduce a breaking change, please describe the impact and migration path for existing applications below. --> | ||
|
||
## Other information | ||
|
||
<!-- Any other information that is important to this PR, such as screenshots of how the component looks before and after the change. --> |
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,78 @@ | ||
--- | ||
- name: "breaking-change" | ||
color: ee0701 | ||
description: "A change that changes the API or breaks backward compatibility for users." | ||
- name: "bugfix" | ||
color: ee0701 | ||
description: "Inconsistencies or issues which will cause a problem for users or implementors." | ||
- name: "documentation" | ||
color: 0052cc | ||
description: "Solely about the documentation of the project." | ||
- name: "enhancement" | ||
color: 1d76db | ||
description: "Enhancement of the code, not introducing new features." | ||
- name: "refactor" | ||
color: 1d76db | ||
description: "Updating the code with simpler, easier to understand or more efficient syntax or methods, but not introducing new features." | ||
- name: "performance" | ||
color: 1d76db | ||
description: "Improving performance of the project, not introducing new features." | ||
- name: "new-feature" | ||
color: 0e8a16 | ||
description: "New features or options." | ||
- name: "maintenance" | ||
color: 2af79e | ||
description: "Generic maintenance tasks." | ||
- name: "ci" | ||
color: 1d76db | ||
description: "Work that improves the continuous integration." | ||
- name: "dependencies" | ||
color: 1d76db | ||
description: "Change in project dependencies." | ||
|
||
- name: "in-progress" | ||
color: fbca04 | ||
description: "Issue is currently being worked on by a developer." | ||
- name: "stale" | ||
color: fef2c0 | ||
description: "No activity for quite some time." | ||
- name: "no-stale" | ||
color: fef2c0 | ||
description: "This is exempt from the stale bot." | ||
|
||
- name: "security" | ||
color: ee0701 | ||
description: "Addressing a vulnerability or security risk in this project." | ||
- name: "incomplete" | ||
color: fef2c0 | ||
description: "Missing information." | ||
- name: "invalid" | ||
color: fef2c0 | ||
description: "This is off-topic, spam, or otherwise doesn't apply to this project." | ||
|
||
- name: "beginner-friendly" | ||
color: 0e8a16 | ||
description: "Good first issue for people wanting to contribute to this project." | ||
- name: "help-wanted" | ||
color: 0e8a16 | ||
description: "We need some extra helping hands or expertise in order to resolve this!" | ||
|
||
- name: "priority-critical" | ||
color: ee0701 | ||
description: "Must be addressed as soon as possible." | ||
- name: "priority-high" | ||
color: b60205 | ||
description: "After critical issues are fixed, these should be dealt with before any further issues." | ||
- name: "priority-medium" | ||
color: 0e8a16 | ||
description: "This issue may be useful, and needs some attention." | ||
- name: "priority-low" | ||
color: e4ea8a | ||
description: "Nice addition, maybe... someday..." | ||
|
||
- name: "major" | ||
color: b60205 | ||
description: "This PR causes a major bump in the version number." | ||
- name: "minor" | ||
color: 0e8a16 | ||
description: "This PR causes a minor bump in the version number." |
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,64 @@ | ||
name: Build/release | ||
on: | ||
push: | ||
tags: | ||
- "v*" | ||
workflow_dispatch: | ||
jobs: | ||
release_linux_win: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Check out Git repository | ||
uses: actions/checkout@v2.2.0 | ||
|
||
- name: Install Node.js, NPM and Yarn | ||
uses: actions/setup-node@v2.1.5 | ||
with: | ||
node-version: 14 | ||
- name: Get Package Version | ||
uses: nyaa8/package-version@v1 | ||
with: | ||
path: 'package.json' | ||
|
||
- uses: actions/checkout@v2.2.0 | ||
with: | ||
fetch-depth: 0 | ||
- name: Building the Project | ||
working-directory: ./ | ||
run: | | ||
sudo dpkg --add-architecture i386 | ||
sudo apt update | ||
sudo apt install wine64 | ||
sudo apt install wine32 | ||
sudo apt install rpm | ||
sudo apt install build-essential | ||
sudo apt install flatpak flatpak-builder | ||
sudo flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo | ||
sudo flatpak install --assumeyes flathub org.freedesktop.Platform//22.08 org.freedesktop.Sdk//22.08 org.electronjs.Electron2.BaseApp//22.08 | ||
yarn install | ||
yarn dist | ||
yarn electron-builder --win -p never | ||
env: | ||
PKGVER: v${{env.PACKAGE_VERSION}} | ||
|
||
- name: Publishing... | ||
uses: "marvinpinto/action-automatic-releases@latest" | ||
with: | ||
repo_token: "${{ secrets.GITHUB_TOKEN }}" | ||
prerelease: false | ||
automatic_release_tag: ${{env.PKGVER}} | ||
files: | | ||
${{github.workspace}}/dist/*.zip | ||
${{github.workspace}}/dist/*.snap | ||
${{github.workspace}}/dist/*.exe | ||
${{github.workspace}}/dist/*.blockmap | ||
${{github.workspace}}/dist/latest.yml | ||
${{github.workspace}}/dist/*.deb | ||
${{github.workspace}}/dist/*.AppImage | ||
${{github.workspace}}/dist/*.rpm | ||
${{github.workspace}}/dist/latest-linux.yml | ||
${{github.workspace}}/dist/latest-linux-arm64.yml | ||
${{github.workspace}}/dist/*.flatpak | ||
env: | ||
PKGVER: v${{env.PACKAGE_VERSION}} |
Oops, something went wrong.