*Proposed Code Contribution Process*

Based on our discussion, we propose the following process for contributing
to the codebase:

   1.

   *Create an Issue for Any Proposed Change*
   To track any proposed changes to the codebase, developers should first
   create a corresponding issue. While we often have offline discussions, any
   such conversation that involves proposed code changes should be summarized
   and added to the relevant issue. Developers are free to use their preferred
   tools to create diagrams or documents, but the final outputs should be
   attached to the issue.
   2.

   *Include Final Design in the Pull Request (PR) Description*
   If a design document exists for a particular feature or change, it
   should be included or summarized in the PR description. This ensures the
   context and rationale for changes are clearly visible during the review
   process.
   3.

   *Store User-Facing Documentation in the docs Folder*
   Any documentation intended to help users understand or use the system
   should be added to the docs folder in the main repository.
   4.

   *Review Process and Merging Guidelines*
   Reviewers are responsible for ensuring that each PR aligns with the
   design discussed in the associated issue. Any contributor can serve as a
   reviewer. However, only a committer can merge a PR. While a committer
   doesn’t have to review every PR personally, they must verify that the PR
   adheres to the Code Contribution Process before merging.
   5.

   *Sync Discussions Across Channels*
   All development-related discussions from the Texera Slack #dev channel
   and Texera GitHub repo should be synced to this dev mailing list to ensure
   transparency and continuity.

-- 

Sincerely,

Xinyuan Lin

Reply via email to