Update README and CONTRIBUTING guidelines#98
Draft
ioreka wants to merge 6 commits into
Draft
Conversation
ioreka
commented
Jan 6, 2025
ioreka
commented
- Update jobs link from Octopus Energy (deprecated) to Kraken
- Improve the contribution guidelines as they are a little outdated
Closed
Splitting into sections and including a clear Installation section
ioreka
commented
Jan 6, 2025
ioreka
commented
Jan 6, 2025
ioreka
commented
Jan 6, 2025
This commit: - Ensures all contributing instructions now work - Upgrades Prettier to v3.2.5 (and fixes the related issues)
ioreka
commented
Jan 9, 2025
| Markdown files are linted by | ||
| [`markdownlint-cli`](https://github.com/igorshubovych/markdownlint-cli). | ||
| ```sh | ||
| make prettier_check |
Author
There was a problem hiding this comment.
I get a really long output of [warn]s for this that i am reluctant to fix:
Not sure if that's the desired outcome
While troubleshooting the docker daemon issues in the spelling and linting commands, I discovered a missing step for users who (like me) did not have Docker already installed (https://stackoverflow.com/questions/44084846/cannot-connect-to-the-docker-daemon-on-macos). The easiest docs amend was to advise installing the app and having an account.
ioreka
commented
Jan 9, 2025
| npm install -g prettier@3.0.0 | ||
| prettier --version | ||
|
|
||
| Once installed, ensure your editor runs Prettier on a pre-save hook: |
Author
There was a problem hiding this comment.
I see pre-save hook in the cookie-cutter repo too but my Google-fu must be weak because I can't find this term. Is this another way of phrasing eg. Prettier running locally in your IDE when you save?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.