Skip to content

Commit 2f0ca22

Browse files
authored
Merge pull request #31 from AgainIoT/againIoT
Update information as you add information and update your version
2 parents 41c2766 + fa9bf70 commit 2f0ca22

File tree

15 files changed

+64
-18
lines changed

15 files changed

+64
-18
lines changed

content/en/docs/guideForClient/aboutcommunity.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,28 @@ _Community checks whether Description, Code of Conduct, Discussion, and License
2121

2222
This is a explanation used in Repository, which is the first item that is visible to the user, and is a concise description that best describes the topic.
2323

24+
[More about Description](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-new-repository)
25+
2426
### Code of Conduct
2527

2628
**What is Code of Conduct?**
2729

2830
A code of conduct is a document that establishes expectations for behavior for your project’s participants.
2931

32+
[More about Code of Conduct](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)
33+
3034
### Discussion
3135

3236
**What is Discussion?**
3337

3438
Collaborative communication forum for the community around an open source or internal project.
3539

40+
[More about Discussion](https://docs.github.com/en/discussions/quickstart)
41+
3642
### License
3743

3844
**What is License?**
3945

4046
Open source licenses are licenses that comply with the Open Source Definition – in brief, they allow software to be freely used, modified, and shared.
47+
48+
[More about License](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository)

content/en/docs/guideForClient/aboutsecurity.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,28 @@ _Security checks whether Security Policy, Dependabot, CodeQL, Secret Scanning is
2121

2222
You can add a security policy to the repository to provide guidance on how to report security vulnerabilities in your project.
2323

24+
[More about Security Policy](https://docs.github.com/en/enterprise-server@3.6/code-security/getting-started/adding-a-security-policy-to-your-repository)
25+
2426
### Dependabot
2527

2628
**What is Dependabot?**
2729

2830
Dependabot creates Dependabot alerts when a known vulnerability is detected in the dependencies used by the project.
2931

32+
[More about Dependabot](https://docs.github.com/en/code-security/dependabot/dependabot-alerts)
33+
3034
### CodeQL
3135

3236
**What is CodeQL?**
3337

3438
CodeQL can be used to identify vulnerabilities and errors in code. The result is displayed as code scanning warning in GitHub.
3539

40+
[More about CodeQL](https://docs.github.com/en/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql)
41+
3642
### Secret Scanning
3743

3844
**What is Secret Scanning?**
3945

4046
GitHub checks the repository for known types of secrets to prevent inadvertently committed secrets from being used for fraud.
47+
48+
[More about Secret Scanning](https://docs.github.com/en/code-security/secret-scanning/about-secret-scanning)

content/en/docs/guideForClient/abouttemplate.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,16 @@ weight: 120
1313
toc: true
1414
---
1515

16-
_Template checks the presence or absence of Pull-Request Template, Issue Template, README.md, Contributing.md._
16+
_Template checks the presence or absence of Pull-Request Template, Issue Template, README.md, CONTRIBUTING.md._
1717

1818
### Pull-Request Template
1919

2020
**What is Pull-Request Template?**
2121

2222
Pull-Request Template (PR Template) is a template of a PR body that is entered when pr is performed. This standardizes the description format so that the code can be easily understood and looks over the parts that need to be checked during PR.
2323

24+
[More about Pull-Request Template](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)
25+
2426
**What Open-Set-Go has to offer?**
2527

2628
Various Pull-Request Templates currently used by real open-source projects sorted by star.
@@ -35,6 +37,8 @@ Various Pull-Request Templates currently used by real open-source projects sorte
3537

3638
Issue templates are summarized and recorded for use in tracking issues or issues that arise during the project.
3739

40+
[More about Issue Template](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository)
41+
3842
**What Open-Set-Go has to offer?**
3943

4044
Provide appropriate Issue Templates for different situations. You can write the name and description of the issue template to suit you, and you can also set the title if you want. In addition, you can add as many issue templates as you want.
@@ -48,6 +52,8 @@ Provide appropriate Issue Templates for different situations. You can write the
4852

4953
README.md is the first document to be viewed in the repository and describes the project. You have information about other files contained in a directory or compressed file.
5054

55+
[More about README.md](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)
56+
5157
**What Open-Set-Go has to offer?**
5258

5359
Various README.md currently used by real open-source projects sorted by star. Templates can be provided separately by type, such as title and description, so that users can use them in combination as they want.
@@ -57,15 +63,17 @@ Various README.md currently used by real open-source projects sorted by star. Te
5763
- Use a combination of the types you want to modify the text.
5864
- Create new ones to suit your needs with the markdown editor.
5965

60-
### Contributing.md
66+
### CONTRIBUTING.md
67+
68+
**What is CONTRIBUTING.md?**
6169

62-
**What is Contributing.md?**
70+
CONTRIBUTING.md is a document that specifies information for contributors. This file can contain various information such as build requirements, development environment setting methods, and code writing guides.
6371

64-
CONTRIBUTING.md is a document that specifies information for contributors. This file can contain various information such as build requirements, development environment setting methods, and code writing guides
72+
[More about CONTRIBUTING.md](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)
6573

6674
**What Open-Set-Go has to offer?**
6775

68-
Various Contributing.md currently used by real open-source projects sorted by star. Templates can be provided separately by type, such as title and description, so that users can use them in combination as they want.
76+
Various CONTRIBUTING.md currently used by real open-source projects sorted by star. Templates can be provided separately by type, such as title and description, so that users can use them in combination as they want.
6977

7078
- Use the template as it is.
7179
- Use the markdown editor to modify and use the template to suit you.

content/en/docs/guideForClient/tutorial.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,13 @@ When you proceed with yourself or membership/login, choose a repository that has
5959

6060
Divided into templates, communities, and security, the parts that have not been evaluated are marked in red circles.
6161

62-
- Template checks the presence or absence of Pull-Request Template, Issue Template, README.md, Contributing.md. [More about Template](https://docs.open-set-go.com/docs/guideForClient/abouttemplate/)
62+
- Template checks the presence or absence of Pull-Request Template, Issue Template, README.md, CONTRIBUTING.md. [More about Template](https://docs.open-set-go.com/docs/guideForClient/abouttemplate/)
6363
- Community checks whether Description, Code of Conduct, Discussion, and License are enabled. [More about Community](https://docs.open-set-go.com/docs/guideForClient/aboutcommunity/)
6464
- Security checks whether Security Policy, Dependabot, CodeQL, Secret Scanning is enabled. [More about Security](https://docs.open-set-go.com/docs/guideForClient/aboutsecurity/)
6565

6666
3.**Project Operational Assessment**
6767

68-
If you want to fill the gaps in the template part, you can select, modify, and create templates as in the start function by clicking on each Pull-Request Template, Issue Template, README.md , and Contributing.md.
68+
If you want to fill the gaps in the template part, you can select, modify, and create templates as in the start function by clicking on each Pull-Request Template, Issue Template, README.md , and CONTRIBUTING.md.
6969

7070
4.**Create Pull Request**
7171

content/en/docs/guideForDevelopment/contribute.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ weight: 160
1313
toc: true
1414
---
1515

16-
_You can also check this out on Contributing.md on our GitHub. [Shortcut of Contributing.md](https://github.com/AgainIoT/Open-Set-Go/blob/main/CONTRIBUTING.md)_
16+
_You can also check this out on CONTRIBUTING.md on our GitHub. [Shortcut of CONTRIBUTING.md](https://github.com/AgainIoT/Open-Set-Go/blob/main/CONTRIBUTING.md)_
1717

1818
### Welcome to Open-Set-Go contributing guide
1919

@@ -112,14 +112,6 @@ _For more information, see [CODE_OF_CONDUCT.md](https://github.com/AgainIoT/Open
112112

113113
We are developing using GitLab-flow. See [GitLab-flow](https://about.gitlab.com/blog/2023/07/27/gitlab-flow-duo/) for more information.
114114

115-
#### For Contributors
116-
117-
<img src="https://github.com/AgainIoT/Open-Set-Go/blob/main/.github/images/contributors_branching.jpg?raw=true"/>
118-
119-
#### For Collaborators
120-
121-
<img src="https://github.com/AgainIoT/Open-Set-Go/blob/main/.github/images/collaborators_branching.jpg?raw=true"/>
122-
123115
### Commit Message Style
124116

125117
| 타입 | 내용 |

content/en/docs/help/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,5 @@ weight: 160
1313
toc: true
1414
---
1515
{{< details "Q. How do you contribute to the Open-Set-Go project?" >}}
16-
To learn how to contribute, visit contributing.md. [Shortcut to contributing.md](http://github.com/AgainIoT/Open-Set-Go/blob/main/CONTRIBUTING.md)
16+
To learn how to contribute, visit CONTRIBUTING.md. [Shortcut to CONTRIBUTING.md](http://github.com/AgainIoT/Open-Set-Go/blob/main/CONTRIBUTING.md)
1717
{{< /details >}}
2.87 KB
Loading

content/en/showcase/open-set-go/index.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,12 @@ homepage: false
1616

1717
## Introduction
1818

19-
'Project Starting Toolkit' for open SW developers who can easily and easily start an Open Source project
19+
'The Open-Source Management Platform' for Open-Source Developers that provides the creation of new open-source projects and operational review for existing projects.
2020

2121
## Functionalities
2222

23+
### 1. Create Repository
24+
2325
<img src="repo.png" width="28"> **Repository**
2426

2527
Create repository and create .gitignore file with language, framework, and os information.
@@ -44,6 +46,34 @@ Users can select from multiple presets what they want to write in their projects
4446

4547
Select and insert a preset for each content, and you can write the details according to your project by referring to the preset.
4648

49+
### 2. Review
50+
51+
<img src="review.png">
52+
53+
There is a review function to evaluate whether an already created repository is suitable for an open-source project. Evaluate the 12 capabilities provided by the hub to build an open-source project environment in three categories. This evaluation of operations understands and enables these 12 factors to effectively run open-source projects.
54+
55+
**Summary** <img src="summary.png">
56+
57+
The Summary provides a brief summary of the results of the operational evaluation. You can select only the items you want and check them with a graph, or you can check the quantity of each item.
58+
59+
<img src="none.png">
60+
61+
Does not exist or is not active
62+
63+
<img src="checked.png">
64+
65+
Exists and Active
66+
67+
<img src="need authority.png">
68+
69+
Owner or more privileges required
70+
71+
**Notification** <img src="noti.png">
72+
Notification provides a description of 'need authority' and 'None'. Provides a brief description of when an item does not have access or fails.
73+
74+
**Add Template** <img src="review_pr.png">
75+
When the user modifies the template and clicks the Complete button, a pull-request is created for the selected repository. You can add an Issue Template, Pull-Request Template, README.md , and Contributing.md the same as you did with the Create Repository.
76+
4777
## Website
4878

4979
[<li> GitHub](https://github.com/AgainIoT/Open-Set-Go)
55.8 KB
Loading
Loading
2.21 KB
Loading
12.1 KB
Loading
186 KB
Loading
139 KB
Loading
21.6 KB
Loading

0 commit comments

Comments
 (0)