Skip to content

docs: add contributor ladder and code attribution guide #273

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

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

alabulei1
Copy link
Collaborator

@alabulei1 alabulei1 commented Jul 1, 2025

Add necessary content to the contributor guide

@alabulei1 alabulei1 requested review from hydai and juntao as code owners July 1, 2025 08:34
Copy link
Member

juntao commented Jul 1, 2025

Hello, I am a PR summary agent on flows.network. Here are my reviews of code commits in this PR.


Overall Summary

Potential Issues and Errors

  • Typo in the "Contributor Ladder" section title.
    • Found: Contriboutr Ladder
    • Corrected: Contributor Ladder

Most Important Findings

  1. Documentation Updates:

    • Renamed "New Contributor Guide" to "Contributor Guide."
    • Added new sections: "Open Source License Guidelines" with instructions on license compatibility and proper attribution for contributed code, including examples; "Contributor Ladder" detailing the path from contributor to maintainer.
  2. Format Adjustments:

    • Updated commit message format check to reference Conventional Commits.
    • Standardized capitalization in the Code of Conduct checklist item.
  3. Minor Changes:

    • Added a link to an open source license guidelines best practice example.
    • Made minor text adjustments for clarity and consistency.
  4. New Additions:

    • Included a statement encouraging contributors to review the project's Code of Conduct.

Overall Impact

The PR significantly enhances the contributor documentation by adding comprehensive guidelines on license compatibility, code attribution, and the path to becoming a maintainer. It also reinforces community standards by emphasizing adherence to the Code of Conduct. Minor text adjustments improve readability and consistency throughout the guide.

Note: Ensure all links are functioning correctly after merging to avoid navigation issues for users.

Details

Commit 6cd3ac00ec18e042af30794417514a3f6c1972c1

Key Changes:

  1. Documentation Updates:

    • Updated the title of the contribution guide from "New Contributor Guide" to "Contributor Guide."
    • Added new sections:
      • Open Source License Guidelines: Instructions on license compatibility and proper attribution for contributed code, with examples.
      • Contributor Ladder: Information about the path from contributor to maintainer.
  2. Format Adjustments:

    • Updated the commit message format check to reference Conventional Commits.
    • Standardized capitalization in the "Code of conduct" checklist item.

Minor Changes:

  • Added a link to a best practice example for open source license guidelines.
  • Minor text adjustments for clarity and consistency.

Commit fa9c398ac478ee7964db59b963fcc83e3de01c35

Key Changes Summary

  1. Corrected a broken link:
    • Fixed the "Contriboutr Ladder" to "Contributor Ladder" in the contribute.md document.

This change ensures that the documentation accurately links to the correct section, improving user experience and navigation within the documentation.

Commit 6f9f4521e2f00cbb994ad76c9e0dd5f49a2d86cf

Summary of Key Changes

  1. Added Link to Code of Conduct:

    • Inserted a statement encouraging contributors to review the project's Code of Conduct.
    • This addition emphasizes the importance of maintaining a welcoming and inclusive community.
  2. Minor Text Adjustments:

    • Slightly modified the existing text for better flow and readability.
    • Added some spacing before introducing the Code of Conduct to make it stand out more clearly.

Overall Impact

  • The primary change is the inclusion of a link to the Code of Conduct, which reinforces the project's commitment to a positive community environment.

Signed-off-by: alabulei1 <[email protected]>
@hydai hydai marked this pull request as draft July 1, 2025 18:05
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