Skip to content

docs: add CONTRIBUTING.md with build instructions and PR workflow (Closes #3) - #144

Open
18680368135 wants to merge 3 commits into
cuentaprueba244w-dotcom:mainfrom
18680368135:add-contributing-guide
Open

docs: add CONTRIBUTING.md with build instructions and PR workflow (Closes #3)#144
18680368135 wants to merge 3 commits into
cuentaprueba244w-dotcom:mainfrom
18680368135:add-contributing-guide

Conversation

@18680368135

Copy link
Copy Markdown

Summary

Add comprehensive CONTRIBUTING.md with setup instructions, build commands, and PR workflow guidelines.

Changes

  • Added CONTRIBUTING.md covering cloning, dependencies, build commands, diagnostic logs, PR workflow, code style, and testing
  • Links to pull_request_template.md
  • References .editorconfig formatting rules

Testing

  • Verified file exists with all required sections
  • Verified build commands documented (python3 build.py)
  • Verified PR workflow steps (fork, branch, commit, pull request)
  • Verified link to pull_request_template.md
  • Verified .editorconfig reference
  • Verified cloning and dependency instructions

Checklist

  • Relevant modules affected by these changes build locally
  • Tests pass locally
  • Diagnostic build log is committed in this PR
  • Documentation has been updated, if applicable
  • Configuration or schema changes are documented, if applicable
  • No generated build artifacts are committed, except the required diagnostic build log
  • Changes are scoped to the PR purpose and avoid unrelated cleanup
  • Security, privacy, and error-handling implications have been considered

  • I would like to request that my diagnostic build log is removed before merging

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.

1 participant