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

Update docs (CONTRIBUTING.md) #1053

Merged
merged 21 commits into from
Dec 14, 2024
Merged

Conversation

lessuselesss
Copy link
Contributor

Relates to:

#1048

Risks

Low - Documentation change only, no code changes involved.

Background

What does this PR do?

Improves the branch naming documentation in CONTRIBUTING.md by:

  1. Fixing nested list numbering
  2. Standardizing example formatting
  3. Using a clearer example number

What kind of change is this?

Improvements (misc. changes to existing features)

Documentation changes needed?

My changes require a change to the project documentation.
I have updated the documentation accordingly.

Testing

Where should a reviewer start?

Review the nested list numbering under step 3 in the "How to Contribute" section of CONTRIBUTING.md.

Detailed testing steps

  1. Verify that the nested list under step 3 uses correct sequential numbering (1, 2)
  2. Check that the Markdown renders correctly by:
    • Viewing the file on GitHub
    • Verifying the numbers appear as "1." and "2." in the rendered view
    • Confirming proper indentation is maintained
  3. Ensure the changes maintain the document's readability and flow

The change is simple but important for maintaining professional documentation standards. The rendered view should show proper sequential numbering rather than two "1." entries.

The changes are straightforward:

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.
-    1. eg. 40--add-test-for-bug-123
+    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

Discord username

Adam Turner | lessuseless
ar4s_45979

@monilpat monilpat changed the base branch from main to develop December 13, 2024 23:04
@lalalune lalalune merged commit 924e171 into elizaOS:develop Dec 14, 2024
3 of 4 checks passed
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.

2 participants