Skip to content

Commit 21bb34d

Browse files
committed
docs: project documentation
1 parent c5e0e78 commit 21bb34d

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

pkg/config/config.go

+6-6
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ import (
1111
"gopkg.in/yaml.v3"
1212
)
1313

14-
// Settings represents the configuration aspects and authorization.
14+
// Settings represents the configuration and authorization aspects.
1515
type Settings struct {
1616
Layout Layout `yaml:"layout"`
1717
Github Github `yaml:"github"`
1818
}
1919

20-
// Layout represents permissions level and pull request funcionalities.
20+
// Layout represents permissions level and pull request functionalities.
2121
type Layout struct {
2222
Administration Administration `yaml:"administration"`
2323
PullRequest PullRequest `yaml:"pullRequest"`
@@ -28,7 +28,7 @@ type Administration struct {
2828
Permission Permission `yaml:"permission"`
2929
}
3030

31-
// Permission represents high level user's permissions and repository permission.
31+
// Permission represents high level user's and repository permissions.
3232
type Permission struct {
3333
Users []string `yaml:"users"`
3434
Repositories []Repositories `yaml:"repositories"`
@@ -45,7 +45,7 @@ type Repository struct {
4545
Users []string `yaml:"users"`
4646
}
4747

48-
// PullRequest represents commands and funcionalities.
48+
// PullRequest represents commands and functionalities.
4949
type PullRequest struct {
5050
EnableOverview bool `yaml:"enableOverview"`
5151
OverViewCommand string `yaml:"overViewCommand"`
@@ -56,7 +56,7 @@ type PullRequest struct {
5656
TestSuite TestSuite `yaml:"testSuite"`
5757
}
5858

59-
// TestSuite represents configuration for test cases.
59+
// TestSuite represents configuration for the test cases.
6060
type TestSuite struct {
6161
NamePattern string `yaml:"namePattern"`
6262
Reviewers bool `yaml:"reviewers"`
@@ -75,7 +75,7 @@ type Github struct {
7575
Events []string `yaml:"events"`
7676
}
7777

78-
// ReadConf initialize the yaml configuration
78+
// ReadConf initialize the configuration.
7979
func (c *Settings) ReadConf() {
8080
yamlFile, err := ioutil.ReadFile("build/config-local.yaml")
8181
if err != nil {

0 commit comments

Comments
 (0)