Skip to content

Commit

Permalink
Remove unnecessary newlines in Markdown files
Browse files Browse the repository at this point in the history
Fixing line lengths in Markdown is always such a bother, and just not necessary. Soft wrap exists for a reason. In code, finite line length makes sense, but in prose it does not, since it is displayed soft-wrappedly anyway!
  • Loading branch information
FWDekker committed Sep 28, 2024
1 parent 694133b commit 6cf4e3a
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 109 deletions.
23 changes: 11 additions & 12 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Contribution guidelines
Thank you for considering contributing!
[All contributions of any size are much appreciated!](https://github.com/FWDekker/intellij-randomness#-acknowledgements)

You can contribute in many ways, whether it's submitting an issue, opening a pull request, or leaving a comment
somewhere.
You can contribute in many ways, whether it's submitting an issue, opening a pull request, or leaving a comment somewhere.
This page provides some guidelines on contributing to Randomness.


Expand All @@ -16,10 +16,16 @@ Several templates are provided to help you structure your issue.


## 🔨 Submit a pull request
Whether you're adding a new feature, fixing a bug, or fixing a typo in documentation, the following guidelines will help
you on your way to submitting a good pull request.
Whether you're adding a new feature, fixing a bug, or fixing a typo in documentation, the following guidelines will help you on your way to submitting a good pull request.
Pull requests that do not meet the following guidelines are **fine**; these are just guidelines after all.

### 🗃️ Coding conventions
This project maintains the [Kotlin coding conventions](https://kotlinlang.org/docs/reference/coding-conventions.html).
[Detekt](https://github.com/arturbosch/detekt/) will, amongst others, check these coding conventions.
Check the [README](../README.md) for instructions on using tools such as Detekt.

Additionally, please make sure you write [good commit messages](https://chris.beams.io/posts/git-commit/).

### 📚 Documentation
Always update related documentation, both code documentation and user instructions such as the [README](../README.md).
Additionally, make sure you update the [change notes](../CHANGELOG.md) if necessary.
Expand All @@ -30,14 +36,7 @@ If you need help writing tests you can open a pull request with your work in pro

Always run tests and static analysis before opening a pull request.

### 🗃️ Coding conventions
This project maintains the [Kotlin coding conventions](https://kotlinlang.org/docs/reference/coding-conventions.html).
[Detekt](https://github.com/arturbosch/detekt/) will, amongst others, check these coding conventions.
Check the [README](../README.md) for instructions on using tools such as Detekt.

Additionally, please make sure you write [good commit messages](https://chris.beams.io/posts/git-commit/).


## 🗞️ Publishing a release
## 🗞️ Publish a release
When it's time for a new release, check the [release checklist](RELEASE_CHECKLIST.md) to make sure everything is in
order.
9 changes: 3 additions & 6 deletions .github/RELEASE_CHECKLIST.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Release checklist
## Documentation
* Bump the version number according to [Semantic Versioning](https://semver.org/).
* Update [`README.md`](../README.md), [`CHANGELOG.md`](../CHANGELOG.md), and
[`description.html`](../src/main/resources/META-INF/description.html) if necessary.
* Update [`README.md`](../README.md), [`CHANGELOG.md`](../CHANGELOG.md), and [`description.html`](../src/main/resources/META-INF/description.html) if necessary.
* Make sure to preview the change notes in the IDE by loading the plugin.
* Make sure that even subsections with a single item use bullet points, otherwise the entry will not show in the IDE.
* Make sure the list of acknowledgements is up-to-date.
Expand All @@ -11,8 +10,7 @@
* Use the project in `src/test/resources/screenshots/` to store code snippets in.
Do not store `.idea/`, `.gradle`, and similar build files in this project.
* Hide (inlay) hints and set font size to 20.
* Distance between bottom of "Refresh" button and top of button bar at bottom is 50 pixels, or the original
distance, whichever is smaller.
* Distance between bottom of "Refresh" button and top of button bar at bottom is 50 pixels, or the original distance, whichever is smaller.
* On Linux, the screen can be recorded using [peek](https://github.com/phw/peek) or
[SimpleScreenRecorder](https://www.maartenbaert.be/simplescreenrecorder/).
* Reducing GIF size is a difficult process.
Expand All @@ -24,8 +22,7 @@
2. "Optimize Transparency" with 2% fuzz
3. "Lossy GIF" with compression level 30
* Ensure documentation generates without errors.
After the release, the [`cd.yml` workflow](https://github.com/FWDekker/intellij-randomness/actions/workflows/cd.yml)
should automatically update the `gh-pages` branch.
After the release, the [`cd.yml` workflow](https://github.com/FWDekker/intellij-randomness/actions/workflows/cd.yml) should automatically update the `gh-pages` branch.
Check that the build action does not fail!

## Verification
Expand Down
15 changes: 5 additions & 10 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,14 @@
# Security policy
The security of Randomness is important to me.
If you find a vulnerability in Randomness, please
[report the vulnerability](https://github.com/FWDekker/intellij-randomness/security/advisories/new) as soon as possible.
If you find a vulnerability in Randomness, please [report the vulnerability](https://github.com/FWDekker/intellij-randomness/security/advisories/new) as soon as possible.

Please note that Randomness is distinct from IntelliJ and other IDEs developed by JetBrains.
To report a vulnerability in IntelliJ or another JetBrains product, please
[check JetBrains' security policy](https://www.jetbrains.com/privacy-security/).
To report a vulnerability in IntelliJ or another JetBrains product, please [check JetBrains' security policy](https://www.jetbrains.com/privacy-security/).

## Supported versions
Only the [latest version of Randomness](https://github.com/FWDekker/intellij-randomness/releases/latest) is ever
supported and supplied with security patches.
Only the [latest version of Randomness](https://github.com/FWDekker/intellij-randomness/releases/latest) is ever supported and supplied with security patches.

## Reporting a vulnerability
To report a vulnerability in Randomness, please use
[GitHub's vulnerability reporting feature](https://github.com/FWDekker/intellij-randomness/security/advisories/new).
To report a vulnerability in Randomness, please use [GitHub's vulnerability reporting feature](https://github.com/FWDekker/intellij-randomness/security/advisories/new).
You will be contacted as soon as possible.
You will be thanked publicly for reporting the vulnerability, unless you indicate that you prefer to be thanked
anonymously.
You will be thanked publicly for reporting the vulnerability, unless you indicate that you prefer to be thanked anonymously.
Loading

0 comments on commit 6cf4e3a

Please sign in to comment.