docs: Added Arch Linux commands to contributing guideline and various minor changes#437
Merged
tomlin7 merged 8 commits intotomlin7:mainfrom Oct 24, 2024
Merged
docs: Added Arch Linux commands to contributing guideline and various minor changes#437tomlin7 merged 8 commits intotomlin7:mainfrom
tomlin7 merged 8 commits intotomlin7:mainfrom
Conversation
Contributor
Author
|
Implements the changes as mentioned in #408 |
Contributor
Author
|
Btw, I believe a tag needs to be added for this PR to count towards Hacktoberfest. |
Contributor
Author
|
Just wanted to mention, was the including of the code blocks in the code blocks intended? |
Owner
|
@shirsakm you might've noticed the mkdocs config in the root directory, |
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.
I have added the commands to be run on Arch Linux for setting up the project when contributing, and other minor changes.
Here is a list of the changes I have made,
Added Arch Linux commands
Added a step to add a virtual environment
I find this to be an important step as otherwise there could be dependency conflicts which would result in issues being opened, which are unrelated to the project completely. Moreover, it can be hard to diagnose sometimes.
Moved the important note above the
poetry installstepThe system packages have to be installed before, and having it afterwards can result in it being missed.
Added
$in front of the commandsIt is the standard way to represent a bash prompt, and helps distinguish the various commands, improving readability.
Moved the Python version requirement into a note.
Please let me know if there are any issues, or any edits that go against the formatting guidelines.