stanford-oval / storm

An LLM-powered knowledge curation system that researches a topic and generates a full-length report with citations.
http://storm.genie.stanford.edu
MIT License
13.47k stars 1.24k forks source link

Establish Clear Contribution Guidelines #93

Open rmcc3 opened 4 months ago

rmcc3 commented 4 months ago

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:

shaoyijia commented 4 months ago

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.