Add `dev-sandbox`

[benloh]

In GitLab by @benloh on Jan 13, 2021, 14:36

Add a new base dev-sandbox branch for developers and researchers to try out developing custom features.

This also adds a new feat-sandbox.ts feature specifically for testing feature development without clobbering existing features.

All developers should work off a branch of dev-sandbox. Prefix your branch with dev and your initials, e.g. for Ben, dev-bl.

e.g. if Ben wants to try out a new feature seek, he'd:

1. Check out dev-sandbox.
2. Pull the latest changes.
3. Create a new branch dev-bl/seek
4. If working on this over a long period of time, it might be necessary to periodically merge dev-sandbox into your local dev-bl/seek branch to keep up with changes.
5. When the feature is complete and tested, if it needs to be merged into the main dev-sandbox branch, create a Merge Request.

In general, when playing with feature development the only file you need to touch ought to be feat-sandbox.ts. Keep in mind however, that other developers and researchers might also be modifying feat-sandbox.ts.

IMPORTANT:

• Changes in your local dev (e.g. dev-bl/seek) should NEVER be merged directly into dev, only to dev-sandbox.
• Merges should only be done via Merge Requests.

[benloh]

In GitLab by @daveseah on Jan 13, 2021, 15:20

After discussion with Ben, I'm pushing for making a feat-template.ts file with instructions for adding a feature to the system. It is pretty easy:

1. copy the feat-template.ts file and name it feat-whatever.ts
2. change the last line where INSTANCE = new GFeature('FeatureName') to what you want to call the feature in the script (e.g. useFeature FeatureName)
3. add the import to sim-features to make it available to the sim engine

I'll make these modifications and repush

[benloh]

In GitLab by @daveseah on Jan 13, 2021, 16:01

added 1 commit

• 17e8aea9 - dev-sandbox: replace 'feat-sandbox.ts' with 'feat-template.ts' with

Compare with previous version

[benloh]

In GitLab by @daveseah on Jan 13, 2021, 16:09

added 1 commit

• d227a1de - dev-sandbox: remove stale reference to feat-sandbox.ts, clarify what

Compare with previous version

[benloh]

In GitLab by @daveseah on Jan 13, 2021, 16:19

added 2 commits

• ec447df2 - dev-sandbox: fix reference to Sandbox in default script, replace with
• 30c43880 - dev-sandbox: renamed the Feature class to GFeature so when discussing

Compare with previous version

[benloh]

In GitLab by @daveseah on Jan 13, 2021, 16:20

I've also renamed the Feature class to GFeature to help know when we're talking about a software feature versus the technical name of the implementation within the codebase. When we say 'feature' we mean the former, when we say 'geefeature' we mean the latter.

[benloh]

In GitLab by @daveseah on Jan 13, 2021, 16:20

The feat-template.ts comments are a good place to start expanding the overall documentation for the rest of the team too!

[benloh]

In GitLab by @benloh on Jan 13, 2021, 17:21

Verified. Compiles and works.

[benloh]

In GitLab by @benloh on Jan 13, 2021, 17:21

mentioned in commit 90b354e0d65a8301a1c0882b9ff99ba2b39ebbb6