unitycatalog / unitycatalog/unitycatalog
Revisit Project Layout
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 3.5k
- Forks
- 672
- Avg merge
- 6d 16h
- Merged PRs (30d)
- 30
Description
Recently, there has been some discussion (see #551) about the best practices for the layout of the Unity Catalog project. The following changes been suggested by @jaceklaskowski:
CODE_OF_CONDUCT.mdandCONTRIBUTING.mdthat should really be under.githubmkdocs.ymlandrequirements-docs.txtshould be underdocsversion.sbtunderproject- All docker related things under
docker/rather than in the project root.
Would a maintainer care to make a decision all of the above, and open up a PR to tidy and rearrange the aforementioned files?
CC: @dennyglee
Originally posted by @jaceklaskowski in https://github.com/unitycatalog/unitycatalog/issues/551#issuecomment-2425028123
Contributor guide
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
Read the discussion in #551 first, then inspect the repository root and the proposed destinations .github, docs, project, and docker/. Done means a maintainer has decided which layout changes to accept and the named files are arranged accordingly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, java, scala
- Domain
- build-system, devops, documentation
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100