Add comprehensive documentation for fx-test repo

This commit is contained in:
Vish
2026-03-14 21:35:38 -07:00
parent 3b9d759b4b
commit aa313bdcaa
5 changed files with 204 additions and 0 deletions

12
docs/contributing.md Normal file
View File

@@ -0,0 +1,12 @@
# 🤝 Contributing Guidelines
We welcome contributions! Please follow these steps:
1. **Fork** the repository.
2. Create a feature branch: `git checkout -b feature/awesome-feature`.
3. Implement your change locally and run `./fluxer/scripts/run_dev.sh` to ensure the stack builds.
4. Run the CI tests: `./fluxer/scripts/ci/workflows/ci.py`.
5. Commit with a clear message: `git commit -m "Add feature: …"`.
6. Push and open a pull request.
Adhere to the existing code style. All patches should include relevant tests.