Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to the codestyle #702

Merged
merged 2 commits into from
Jan 13, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Now diKTat was already added to the lists of [static analysis tools](https://git

| | | | |
| --- | --- | --- | --- |
|[DiKTat codestyle](info/guide/diktat-coding-convention.md)|[Supported Rules](info/available-rules.md) | [Examples of Usage](https://github.com/akuleshov7/diktat-examples) | [Online Demo](https://ktlint-demo.herokuapp.com) |
|[DiKTat codestyle](info/guide/diktat-coding-convention.md)|[Supported Rules](info/available-rules.md) | [Examples of Usage](https://github.com/akuleshov7/diktat-examples) | [Online Demo](https://ktlint-demo.herokuapp.com) | [Whitepaper](wp/wp.pdf) |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you decided to upload pdf to repo after all? Or we could add link to README in #655, as we planned, with link to gh releases.

Copy link
Member Author

@orchestr7 orchestr7 Jan 13, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, will after all we will need to add pdf


## Why should I use diktat in my CI/CD?

Expand Down
2 changes: 1 addition & 1 deletion info/buildSrc/gradle.properties
Original file line number Diff line number Diff line change
@@ -1 +1 @@
version=0.2.1-SNAPSHOT
version=0.3.1-SNAPSHOT
8 changes: 8 additions & 0 deletions info/guide/diktat-coding-convention.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<img src="logo.svg" width="64px"/>

# Diktat Coding Style Guide, v.0.0.1

# Table of contents
I [Preface](#c0)
Expand Down Expand Up @@ -107,6 +110,11 @@ I [Preface](#c0)
* [6.4.2 Objects should be used for Stateless Interfaces](#r6.4.2)


# Diktat Coding Style Guide
# International version, v.0.0.1

<img src="logo.svg" width="64px"/>

## <a name="c0"></a> Preface
<!-- =============================================================================== -->
### <a name="c0.1"></a> Purpose of this document
Expand Down
3 changes: 3 additions & 0 deletions info/guide/guide-TOC.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<img src="logo.svg" width="64px"/>

# Diktat Coding Style Guide, v.0.0.1
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How will we track these versions?

Copy link
Member Author

@orchestr7 orchestr7 Jan 13, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I actually think that it is enough to have the version here, I do not like to put it into separate file later


# Table of contents
I [Preface](#c0)
Expand Down
5 changes: 5 additions & 0 deletions info/guide/guide-chapter-0.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# Diktat Coding Style Guide
# International version, v.0.0.1

<img src="logo.svg" width="64px"/>

## <a name="c0"></a> Preface
<!-- =============================================================================== -->
### <a name="c0.1"></a> Purpose of this document
Expand Down
Loading