Skip to content

Commit

Permalink
Added codacy config file & 🎨
Browse files Browse the repository at this point in the history
Took 23 minutes
  • Loading branch information
Fank committed Sep 3, 2024
1 parent eb0e7aa commit 3a7e278
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .chglog/CHANGELOG.tpl.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@
{{ end }}
{{ end -}}
{{ end -}}
{{ end -}}
{{ end -}}
3 changes: 3 additions & 0 deletions .codacy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
exclude_paths:
- "**/*_test.go"
24 changes: 24 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# EditorConfig is awesome: http://EditorConfig.org

# top-most EditorConfig file
root = true

# every file
[*]
indent_style = tab
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

# config files
[*.{yml,yaml}]
indent_style = space
indent_size = 2

# markdown documentation
[*.md]
indent_style = space
indent_size = 2
trim_trailing_whitespace = false
1 change: 0 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -601,4 +601,3 @@
### Pull Requests

* Merge pull request [#1](https://github.com/ctreminiom/go-atlassian/issues/1) from ctreminiom/dev

24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,17 +48,17 @@ go get github.com/ctreminiom/go-atlassian
## 📪 Packages
Then import the package into your project as you normally would. You can import the following packages:

| Module | Path | URL's |
|---------------------------------|----------------------------------------------------------|-------------------------------------------------------------------------------------- |
| Jira v2 | `github.com/ctreminiom/go-atlassian/jira/v2` | [Getting Started](https://docs.go-atlassian.io/jira-software-cloud/introduction) |
| Jira v3 | `github.com/ctreminiom/go-atlassian/jira/v3` | [Getting Started](https://docs.go-atlassian.io/jira-software-cloud/introduction) |
| Jira Software Agile | `github.com/ctreminiom/go-atlassian/jira/agile` | [Getting Started](https://docs.go-atlassian.io/jira-agile/introduction) |
| Jira Service Management | `github.com/ctreminiom/go-atlassian/jira/sm` | [Getting Started](https://docs.go-atlassian.io/jira-service-management/introduction) |
| Jira Assets | `github.com/ctreminiom/go-atlassian/assets` | [Getting Started](https://docs.go-atlassian.io/jira-assets/overview) |
| Confluence | `github.com/ctreminiom/go-atlassian/confluence` | [Getting Started](https://docs.go-atlassian.io/confluence-cloud/introduction) |
| Confluence v2 | `github.com/ctreminiom/go-atlassian/confluence/v2` | [Getting Started](https://docs.go-atlassian.io/confluence-cloud/v2/introduction) |
| Admin Cloud | `github.com/ctreminiom/go-atlassian/admin` | [Getting Started](https://docs.go-atlassian.io/atlassian-admin-cloud/overview) |
| Bitbucket Cloud *(In Progress)*<br/> | `github.com/ctreminiom/go-atlassian/bitbucket` | [Getting Started](https://docs.go-atlassian.io/bitbucket-cloud/introduction) |
| Module | Path | URL's |

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 93 Warning

Column: 93

Check warning

Code scanning / Markdownlint (reported by Codacy)

Expected: 80; Actual: 188 Warning

Expected: 80; Actual: 188

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 27 Warning

Column: 27

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 186 Warning

Column: 186
|--------------------------------------|----------------------------------------------------------|----------------------------------------------------------------------------------------|
| Jira v2 | `github.com/ctreminiom/go-atlassian/jira/v2` | [Getting Started](https://docs.go-atlassian.io/jira-software-cloud/introduction) |

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 93 Warning

Column: 93

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 186 Warning

Column: 186

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 27 Warning

Column: 27
| Jira v3 | `github.com/ctreminiom/go-atlassian/jira/v3` | [Getting Started](https://docs.go-atlassian.io/jira-software-cloud/introduction) |

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 93 Warning

Column: 93

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 27 Warning

Column: 27

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 186 Warning

Column: 186
| Jira Software Agile | `github.com/ctreminiom/go-atlassian/jira/agile` | [Getting Started](https://docs.go-atlassian.io/jira-agile/introduction) |

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 186 Warning

Column: 186

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 27 Warning

Column: 27

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 93 Warning

Column: 93
| Jira Service Management | `github.com/ctreminiom/go-atlassian/jira/sm` | [Getting Started](https://docs.go-atlassian.io/jira-service-management/introduction) |

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 93 Warning

Column: 93

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 186 Warning

Column: 186

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 27 Warning

Column: 27
| Jira Assets | `github.com/ctreminiom/go-atlassian/assets` | [Getting Started](https://docs.go-atlassian.io/jira-assets/overview) |

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 27 Warning

Column: 27

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 186 Warning

Column: 186

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 93 Warning

Column: 93
| Confluence | `github.com/ctreminiom/go-atlassian/confluence` | [Getting Started](https://docs.go-atlassian.io/confluence-cloud/introduction) |

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 186 Warning

Column: 186

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 93 Warning

Column: 93

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 27 Warning

Column: 27
| Confluence v2 | `github.com/ctreminiom/go-atlassian/confluence/v2` | [Getting Started](https://docs.go-atlassian.io/confluence-cloud/v2/introduction) |

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 27 Warning

Column: 27

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 186 Warning

Column: 186

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 93 Warning

Column: 93
| Admin Cloud | `github.com/ctreminiom/go-atlassian/admin` | [Getting Started](https://docs.go-atlassian.io/atlassian-admin-cloud/overview) |

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 186 Warning

Column: 186

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 27 Warning

Column: 27

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 93 Warning

Column: 93
| Bitbucket Cloud *(In Progress)*<br/> | `github.com/ctreminiom/go-atlassian/bitbucket` | [Getting Started](https://docs.go-atlassian.io/bitbucket-cloud/introduction) |

Check warning

Code scanning / Markdownlint (reported by Codacy)

Element: br Warning

Element: br

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 97 Warning

Column: 97

Check warning

Code scanning / Markdownlint (reported by Codacy)

Column: 184 Warning

Column: 184

-------------------------
## 🔨 Usage
Expand Down Expand Up @@ -201,4 +201,4 @@ We would like to extend our sincere thanks to the following sponsors for their g
- [GitBook](https://www.gitbook.com/) for providing us non-profit / open-source plan so hence I would like to express my thanks here.

<img align="right" src="./static/jetbrains-logo.svg">
<img align="left" src="./static/gitbook-logo.svg">
<img align="left" src="./static/gitbook-logo.svg">

Check warning

Code scanning / Markdownlint (reported by Codacy)

Images should have alternate text (alt text) Warning

Images should have alternate text (alt text)

Check warning

Code scanning / Markdownlint (reported by Codacy)

Element: img Warning

Element: img

0 comments on commit 3a7e278

Please sign in to comment.