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

Recommend sembr for docs #249

Merged
merged 1 commit into from
Nov 2, 2023
Merged

Conversation

sajayantony
Copy link
Contributor

@sajayantony sajayantony commented Aug 11, 2023

Signed-off-by: Sajay Antony <sajaya@microsoft.com>
@sajayantony
Copy link
Contributor Author

sajayantony commented Aug 11, 2023

@TerryHowe - Do you think we should avoid line breaks at 80 and just do one line a sentence. I couldn't understand if sembr recommends the line breaks or one new sentence per line or both.

@sajayantony sajayantony marked this pull request as draft August 11, 2023 22:50
@TerryHowe
Copy link
Member

I don't need line breaks at 80, but I could go either way on that.

@TerryHowe
Copy link
Member

On second thought, I'd prefer we didn't mandate 80 chars. I'd be breaking that all the time.

@sajayantony
Copy link
Contributor Author

Agreed. I also find holding the 80 char limit hard :)
How about we recommend breaking lines between 80-120 but ensure that sentences are on new lines?

@TerryHowe
Copy link
Member

Does this need to be a draft still?

@sajayantony sajayantony marked this pull request as ready for review October 30, 2023 21:01
@sajayantony
Copy link
Contributor Author

Update review status @TerryHowe

Copy link
Member

@TerryHowe TerryHowe left a comment

Choose a reason for hiding this comment

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

/lgtm

@sajayantony
Copy link
Contributor Author

@shizhMSFT @FeynmanZhou any concerns?

Copy link
Contributor

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

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

LGTM

@sajayantony sajayantony merged commit 8890118 into oras-project:main Nov 2, 2023
6 checks passed
@sajayantony sajayantony deleted the sembr branch November 2, 2023 07:34
TerryHowe pushed a commit to TerryHowe/oras-www that referenced this pull request Jul 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants