docs: streamline repo docs, point to ra-h.app/docs
- Delete CODE_OF_CONDUCT.md (generic boilerplate) - Simplify README.md, link to ra-h.app/docs as primary - Simplify CONTRIBUTING.md - Fix bug_report.md (was referencing PostgreSQL, uses SQLite) - Gut bloated PR template - Simplify feature_request.md - Update docs/README.md to point to website - Update docs/9_open-source.md
This commit is contained in:
+12
-24
@@ -1,24 +1,18 @@
|
||||
# Contributing to RA-H Open Source
|
||||
# Contributing
|
||||
|
||||
This is the **open source mirror** of a private repository. Features are developed privately and synced here periodically.
|
||||
This is the open source mirror of a private repository. Features are developed privately and synced here.
|
||||
|
||||
## How to Contribute
|
||||
**Full docs:** [ra-h.app/docs](https://ra-h.app/docs)
|
||||
|
||||
### Bug Reports & Feature Requests
|
||||
Open an [issue](../../issues). Include:
|
||||
- What you expected vs what happened
|
||||
- Steps to reproduce (for bugs)
|
||||
- Your environment (OS, Node version, browser)
|
||||
## What We Accept
|
||||
|
||||
### Code Contributions
|
||||
We accept pull requests for:
|
||||
- **Bug fixes** - especially ones you've encountered
|
||||
- **Documentation improvements** - typos, clarifications, examples
|
||||
- **Small enhancements** - that don't require architectural changes
|
||||
- **Bug fixes** – especially ones you've encountered
|
||||
- **Doc improvements** – typos, clarifications, examples
|
||||
- **Small enhancements** – that don't require architectural changes
|
||||
|
||||
For **larger features**, open an issue first to discuss. Major features are typically implemented in the private repo and synced here.
|
||||
For larger features, open an issue first. Major features are typically implemented in the private repo and synced here.
|
||||
|
||||
## Development Setup
|
||||
## Setup
|
||||
|
||||
```bash
|
||||
git clone https://github.com/bradwmorris/ra-h_os.git
|
||||
@@ -29,8 +23,6 @@ scripts/dev/bootstrap-local.sh
|
||||
npm run dev
|
||||
```
|
||||
|
||||
Open http://localhost:3000 and add your API keys.
|
||||
|
||||
## Before Submitting a PR
|
||||
|
||||
```bash
|
||||
@@ -50,18 +42,14 @@ All three must pass.
|
||||
|
||||
## What Happens to Your Contribution
|
||||
|
||||
1. We review and merge to this repo
|
||||
2. If applicable, we port the fix to the private repo
|
||||
1. We review and merge here
|
||||
2. If applicable, we port to the private repo
|
||||
3. Future syncs won't overwrite your contribution
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
Be respectful. No harassment, trolling, or personal attacks. Focus on constructive feedback.
|
||||
|
||||
## License
|
||||
|
||||
By contributing, you agree your work is licensed under [MIT](LICENSE).
|
||||
|
||||
## Questions?
|
||||
|
||||
Open a [discussion](../../discussions) or check existing issues.
|
||||
Check [ra-h.app/docs](https://ra-h.app/docs) or open an issue.
|
||||
|
||||
Reference in New Issue
Block a user