Reorganizing respository and front-page
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 306
- Forks
- 119
- Avg merge
- 2d 6h
- Merged PRs (30d)
- 18
Description
All,
Since the user and developer community has been growing, I suggest that we should consider improve usability and maintenability of HecBench. It is no longer single-person project (we appreciate @zjin-lcf to make it happen), and we need to change the way to manage the entire repository, which has also been discussed in #238.
- The directory structure. Currently, 2000+ directories in a single level, making extreme hard to browse and comprehend the content quickly. I suggest m
- The front-page (.md file) is too big. Some of the contents should be composed in separated .md files and directories. In the current format, maintaining the content by average and part-time contributors (all of us follows into this category).
- The outcome of the reorganization will be integrated with HecBench contribution guidance.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the discussion in issue #238 and reviewing the current top-level directory structure and front-page .md file. Identify how the 2000+ directories and front-page content should be reorganized, then verify that the result can be integrated into HecBench contribution guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100