Skip to content

Commit dc9f559

Browse files
Create Foundations for Active Prompt Engine + Contributing MD (#263)
* Create Foundations for Active Prompt Engine + Contributing MD This PR setups the foundations for the Active Prompt data model for Phase 2 of Active Agent. This uses Rails Engines and adds test to be able to setup the initial foundation. * Update CONTRIBUTING.MD * Delete lib/active_prompt/engine.rb * Delete lib/active_prompt/version.rb * Delete lib/active_prompt.rb * Delete lib/activeagent.rb * Delete test/active_prompt_engine_test.rb * Revert "Delete lib/activeagent.rb" This reverts commit 1357769. * Moved into separate project for now --------- Co-authored-by: Justin Bowen <JusBowen@gmail.com>
1 parent ef1841b commit dc9f559

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

CONTRIBUTING.MD

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## Contributing to Active Agent
2+
3+
Thanks for your interest in improving Active Agent! This guide covers the basics for setting up your environment, running tests, linting, and doing a quick local verification that things work.
4+
5+
### Prerequisites
6+
- Ruby with Bundler installed
7+
- Google Chrome/Chromium (recommended for system tests via Cuprite)
8+
9+
### Setup
10+
git clone https://github.com/activeagents/activeagent.git
11+
cd activeagent
12+
bundle install
13+
14+
- Full suite:
15+
bin/test
16+
# or
17+
bundle exec rake test
18+
- Single file:
19+
20+
ruby -Itest test/generation_test.rb
21+
22+
- Tests use Rails’ plugin test runner and a bundled dummy app under `test/dummy`.
23+
- External API calls are recorded with VCR, so you shouldn’t need API keys to run the suite.
24+
25+
### Linting
26+
- bin/lint # check
27+
- bin/lint --fix # safe auto-correct
28+
- bin/lint -A # auto-correct including unsafe### Quick local verification
29+
30+
### Making changes
31+
1. Create a feature branch.
32+
2. Add tests for your change.
33+
3. Run `bin/test` and `bin/lint` until both pass cleanly.
34+
4. Open a pull request with a clear description of the change and motivation.
35+
36+
### Recording or updating VCR cassettes (optional)
37+
If you need to re-record HTTP interactions for specific tests, set the necessary API keys in your environment and run only those tests. Please avoid committing sensitive data; VCR cassettes should only contain sanitized request/response data.
38+
39+
### Community and support
40+
- Documentation: https://docs.activeagents.ai
41+
- Issues: https://github.com/activeagents/activeagent/issues
42+
- Discord: https://discord.com/invite/JRUxkkHKmh
43+
44+
We appreciate your contributions—thank you!

0 commit comments

Comments
 (0)