Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (26 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

37 lines (26 loc) · 1.21 KB
Raw

Contributing to Forge

Forge is a personal fork of xai-org/grok-build. Contributions that improve the Forge extension layer are welcome when they are focused, tested, and easy to carry across upstream updates.

Scope

  • Put substantial fork-specific logic in the appropriate per-crate src/forge/ module.
  • Keep edits to upstream-owned files small and mark integration points with // Forge: where practical.
  • Preserve the stock SpaceXAI login and model paths.
  • Do not combine behavior-neutral refactors with unrelated behavior changes.
  • Send changes that apply only to stock Grok Build to the upstream project.

Before submitting

Run formatting and the focused checks for every affected crate:

cargo fmt --all
cargo check -p <crate>
cargo test -p <crate> <relevant-test-filter>

Describe the behavior being changed, the upstream files touched, and the tests run. Never include credentials, tokens, private configuration, or session data.

Security

Follow SECURITY.md for vulnerability reports. Do not disclose security issues in a public issue or pull request.

License

Contributions are accepted under the repository's Apache License 2.0 terms.