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

Improve branch naming documentation format in CONTRIBUTING.md #1048

Open
lessuselesss opened this issue Dec 13, 2024 · 1 comment
Open

Improve branch naming documentation format in CONTRIBUTING.md #1048

lessuselesss opened this issue Dec 13, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@lessuselesss
Copy link
Contributor

lessuselesss commented Dec 13, 2024

Is your feature request related to a problem? Please describe.

In the CONTRIBUTING.md file, there's some formatting issues in the branch naming section, :

Incorrect nested list numbering (using "1." twice)
Inconsistent formatting for the example (using "eg." instead of "Example:")

This inconsistency with our documentation style could lead to confusion and doesn't match the professional tone of the rest of the document.

Describe the solution you'd like

  1. Use proper sequential numbering (1, 2)
  2. Replace "eg." with "Example:" to match documentation style
  3. Use a more clear example number (9999)

The final format should look like:

3. Fork the repo and create your branch from `main`.
    
    1. The name of the branch should start with the issue number and be descriptive of the changes you are making.  
    2. Example: 9999--add-test-for-bug-123]

Describe alternatives you've considered

  1. Keeping "eg." but it's less formal than our documentation style
  2. Using different formatting like "For example:" or "(example:)" but "Example:" is cleaner
  3. Using a bullet point for the example, but numbered lists better show the relationship between the instruction and its example

Additional context

This change aligns with our documentation styleguide and makes the contribution guidelines more consistent and professional. It's a small change that improves readability and maintains our documentation standards.

@ileana-pr
Copy link
Contributor

Fixed: #1191

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants