Skip to content

Slight fix of the change log entry example#16860

Merged
seanbudd merged 2 commits into
nvaccess:masterfrom
school510587:fix_change_log_entry_doc
Jul 16, 2024
Merged

Slight fix of the change log entry example#16860
seanbudd merged 2 commits into
nvaccess:masterfrom
school510587:fix_change_log_entry_doc

Conversation

@school510587

@school510587 school510587 commented Jul 15, 2024 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

Link to issue number:

None.

Summary of the issue:

None.

Description of user facing changes

None.

Description of development approach

None.

Testing strategy:

Let its style be closer to the actual layout of changes.md.

Known issues with pull request:

None.

Code Review Checklist:

  • Documentation:
    • Change log entry
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • API is compatible with existing add-ons.
  • Security precautions taken.

Summary by CodeRabbit

  • Documentation
    • Reformatted "New Features" and "Changes" sections in the contribution guidelines for better readability.

@school510587
Slight fix of the change log entry example
e3efb8b 
Let it be closer to the actual layout of changes.md.
@school510587 school510587 requested a review from a team as a code owner July 15, 2024 09:56
@coderabbitai

coderabbitai Bot commented Jul 15, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

Walkthrough

The contributing.md file has been updated to improve readability by reformatting the "New Features" and "Changes" sections. This involved converting bullet points into subheadings and adjusting the formatting of the content within these sections to enhance clarity and structure.

Changes

File Change Summary
projectDocs/dev/contributing.md Reformatted "New Features" and "Changes" sections by converting bullet points to subheadings and adjusting the corresponding content formatting.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@school510587 school510587 mentioned this pull request Jul 15, 2024
Merged
5 tasks
@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Jul 15, 2024
SaschaCowley
SaschaCowley requested changes Jul 16, 2024
View reviewed changes
Comment thread projectDocs/dev/contributing.md
Comment thread projectDocs/dev/contributing.md Outdated
@seanbudd seanbudd merged commit 54564bd into nvaccess:master Jul 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@SaschaCowley SaschaCowley SaschaCowley approved these changes

Assignees

No one assigned

Labels

conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@school510587 @SaschaCowley @seanbudd