docs: update contribution guideline #3057
Merged
Conversation
This file contains 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
✗ The generated branch has been deleted.If the PR has been merged, you can check the generated code on the |
|
@millotp could you merge this for me please? I don't have permissions. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
🧭 What and Why
This PR updates the guidelines for writing long descriptions.
Essentially, don't use Markdown in the first sentence/paragraph in the descriptions.
The Algolia CLI uses the Search API spec to generate flags from the API parameter/index settings. The help text is generated from the first sentence of the
descriptionkey.It looks better on the command line if the help text doesn't contain Markdown.
For the most part, I already updated the specs with that in mind. There are some Markdown links, but they will be automatically removed when generating the flags and help text.