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

Establish Clear Contribution Guidelines #93

Open
rmcc3 opened this issue Jul 19, 2024 · 1 comment
Open

Establish Clear Contribution Guidelines #93

rmcc3 opened this issue Jul 19, 2024 · 1 comment

Comments

@rmcc3
Copy link
Contributor

rmcc3 commented Jul 19, 2024

As an open source project, there is a currently lack clear guidelines for contributors. This absence of documentation makes it challenging for new contributors to understand how to effectively participate in the project. Specifically, there's uncertainty around how to structure pull requests for code reviews and other important aspects of the contribution process.

Key Issues to Address:

  1. Lack of clear process for submitting contributions
  2. Uncertainty about how to structure pull requests for effective code reviews
  3. Absence of coding standards and best practices documentation

Proposed Solution:
Create a CONTRIBUTING.md file that addresses these issues and provides clear guidance for contributors. This document should cover:

  1. Introduction to the project and its goals
  2. Step-by-step guide on how to contribute
    • How to set up the development environment
    • Process for finding or creating issues to work on
    • How to fork the repository and create branches
  3. Pull Request guidelines
    • How to structure PRs (e.g., size, scope, breaking up large changes)
    • Commit message format
    • Required documentation or tests
  4. Code review process
    • What to expect during review
    • How to respond to feedback
  5. Coding standards and best practices
  6. Testing requirements
  7. Documentation guidelines

Benefits:

  • Lowers the barrier to entry for new contributors
  • Ensures consistency in contributions and code quality
  • Streamlines the review process for maintainers
  • Improves overall project organization and documentation
@shaoyijia
Copy link
Collaborator

Thank you for the very helpful suggestion! We just add an initial CONTRIBUTING.md to convey what we are specifically looking for help at this stage.

I will keep this issue open and welcome suggestions from everyone.

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

No branches or pull requests

2 participants