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

Add contributor set-up instructions #471

Merged
merged 11 commits into from
Dec 4, 2023
Merged

Add contributor set-up instructions #471

merged 11 commits into from
Dec 4, 2023

Conversation

samwilson
Copy link
Member

Change the main install instructions to target developers, because they're more likely to be the ones following this. #wmhack

Change the main install instructions to target developers,
because they're more likely to be the ones following this.
@samwilson samwilson marked this pull request as draft August 18, 2023 03:21
@waldyrious
Copy link
Collaborator

As previously promised, I've proposed changes to this branch in #475.

@samwilson samwilson marked this pull request as ready for review August 20, 2023 08:33

app:check [-l|--lang LANG] [--nocache] [-t|--title TITLE] [-c|--count COUNT] [-s|--namespaces NAMESPACES]
```console
Copy link
Member Author

Choose a reason for hiding this comment

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

@waldyrious I didn't notice this before, sorry. This section of CLI usage is auto-generated (by this thing), so shouldn't be changed by hand. I thought we had a CI check in place to guard against this; I'm adding such a thing in #476.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Sure, no worries. Would you like me to revert the changes to the "CLI Usage" section, and keep the changes to the other sections?

Copy link
Collaborator

Choose a reason for hiding this comment

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

In the meantime, I submitted samwilson/console-readme-generator#7 to change this formatting in the source.

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks! And no, it's fine to leave them as-is here, I'll merge that change and then we can update the package here.

@samwilson
Copy link
Member Author

Okay, I think this is good to go now.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
samwilson and others added 2 commits December 4, 2023 16:26
Co-authored-by: Waldir Pimenta <waldyrious@gmail.com>
Co-authored-by: Waldir Pimenta <waldyrious@gmail.com>
@samwilson samwilson merged commit 1d23b42 into main Dec 4, 2023
5 checks passed
@samwilson samwilson deleted the contributor-docs branch December 4, 2023 09:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

3 participants