Check-list for making CAMDEN public
- Dominant language
- No language data
- Stars
- 9
- Forks
- 22
- Avg merge
- 8d 5h
- Merged PRs (30d)
- 4
Description
This issue was created to help list out what all should be done before and after CAMDEN has been made public. I view this repo as a discussion, so feel free to add any concerns or suggestions you might have related to this topic.
My current list so far:
**Before being made public:**
1. CAMDEN should be able to run at least one out-of-box compset (e.g. FKESSLER), which requires:
- [x] History output
- [x] Working (ideally fully-updated) dycore (likely SE)
2. CAMDEN should have its first tag, which requires:
- [ ] Deciding on tag naming conventions
- [ ] At least one tag created with that convention with code that satisfies step 1. above.
- [ ] Updating the Github Issue templates to request the tag being used, instead of the hash.
- [ ] The creation of a `ChangeLog` file that records the modifications and test results for each tag.
3. Decide new public location for code:
- [x] Move CAMDEN code over to ESCOMP repo (whether as an ESCOMP/CAM branch or its own repo is TBD)
- [x] Determine the name of the new repo or branch (CAMDEN, SIMA, new_cam, etc.).
**After being made public:**
- [x] Move all open CAMDEN issues over to the ESCOMP repo
- [x] Add newly moved CAMDEN issues to the CAM project page (likely as a separate "view" tab).
Any other things we should make sure of before or immediately after going public?
@cacraigucar @peverwhee @PeterHjortLauritzen @briandobbins
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the unchecked items in this issue, especially tag naming, the first tag, GitHub issue templates, and the ChangeLog. Review the discussion and existing migration checklist to identify unresolved concerns. Done means the public-release requirements are agreed and the listed pre- and post-release tasks are completed.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100