Skip to content

Commit ce39091

Browse files
authored
Initial commit
0 parents  commit ce39091

13 files changed

+68
-0
lines changed

.github/DISCUSSION_TEMPLATE/discussion.yml

Whitespace-only changes.

.github/FUNDING.yml

Whitespace-only changes.

.github/ISSUE_TEMPLATE/config.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Development Help
4+
about: Help on the Development
5+
url: https://github.com/USERNAME/REPOSITORY/discussions
6+
- name: Usage Help
7+
about: Help on the Usage
8+
url: https://github.com/USERNAME/REPOSITORY/discussions

.github/pull_request_template.md

Whitespace-only changes.

.gitignore

Whitespace-only changes.

CITATION.cff

Whitespace-only changes.

LICENSE

Whitespace-only changes.

docs/CODEOWNERS

Whitespace-only changes.

docs/CODE_OF_CONDUCT.md

Whitespace-only changes.

docs/CONTRIBUTING.md

Whitespace-only changes.

docs/README.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# [@Malix-Labs](https://github.com/Malix-Labs) General [Repository Template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)
2+
3+
After creating a repository from the [@Malix-Labs](https://github.com/Malix-Labs) [repository template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template), this file has to be cleared.
4+
It is accessible online at https://github.com/Malix-Labs/Template#readme
5+
6+
## Usage
7+
8+
1. [ ] [Create a repository from this template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template#creating-a-repository-from-a-template)
9+
2. [ ] Copy all [this repository GitHub Settings](https://github.com/Malix-Labs/Template#github-settings)
10+
3. [ ] Copy all [this repository GitHub labels](https://github.com/Malix-Labs/Template#github-labels)
11+
12+
## Features
13+
14+
### [GitHub Labels](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels)
15+
16+
- "Feature" (#00FF00)
17+
- "Enhancement" (#00FFFF)
18+
- "Fix" (#FF8000)
19+
- "Update" (#FFFF00)
20+
- "Deprecation" (#FF0000)
21+
22+
### [GitHub Milestones](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/creating-and-editing-milestones-for-issues-and-pull-requests)
23+
24+
- "v1.0.0"
25+
26+
### [GitHub Issue and Pull Request Template](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)
27+
28+
### [GitHub Project Template](https://docs.github.com/en/issues/planning-and-tracking-with-projects/managing-your-project/managing-project-templates-in-your-organization#copying-a-project-as-a-template)
29+
30+
The best starting [GitHub project template](https://docs.github.com/en/issues/planning-and-tracking-with-projects/managing-your-project/managing-project-templates-in-your-organization#copying-a-project-as-a-template) for any project scale
31+
32+
### [GitHub Discussion Category Form](https://docs.github.com/en/discussions/managing-discussions-for-your-community/creating-discussion-category-forms)
33+
34+
### GitHub Actions
35+
36+
Optimized for [Trunk-Based Development](https://trunkbaseddevelopment.com/)
37+
38+
- On issue create:
39+
- [ ] [Create a branch named as the issue ID and link it to the created issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-a-branch-for-an-issue)
40+
- On first commit push to this branch:
41+
- [ ] Create a [draft pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#marking-a-pull-request-as-ready-for-review) to the [parent issue](https://docs.github.com/en/issues/managing-your-tasks-with-tasklists/about-tasklists#about-tasklists-and-issue-hierarchy:~:text=You%20can%20create-,parent,-and%20child%20relationships) if any, else master
42+
- On push to master:
43+
- [ ] Create a [draft release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#:~:text=release%20later%2C%20click-,Save%20draft,-.%20You%20can%20then) with a tag annoted with the latest semver tag incremented by one patch
44+
45+
### GitHub Files
46+
47+
Fully featued with GitHub files
48+
49+
### GitHub Settings
50+
51+
GitHub Settings cannot be embeded in a [GitHub repository template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) copied data, therefore, you have to [copy them manually](https://github.com/Malix-Labs/Template#github-settings)
52+
53+
<!--
54+
1.
55+
-->

docs/SECURITY.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
Please report any vulnerability in [`/security/advisories`](https://github.com/USERNAME/REPOSITORY/security/advisories)

docs/SUPPORT.md

Whitespace-only changes.

0 commit comments

Comments
 (0)