bazel-contrib / bazel-contrib/rules_scala

have a clear folders layout

Open
#160 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Starlark
Stars
384
Forks
292
Avg merge
2d 21h
Merged PRs (30d)
46

Description

As a new comer to this project I failed to find the logic behind the folders layout, which makes it harder to contribute.

If there is a logic - let's document it and publish it in README.
Else - I suggest finding a good standard layout, ie:
```
.
+-- [src]
+-- [test]
| +-- [unit]
| +-- [integration]
| +-- [scripts] (?)
+-- [libs] / [includes]
+-- [examples]
```

And reorder the project accordingly

Contributor guide

Open the contributing guide

Research direction

Start by mapping the current repository folders and reviewing the README, then determine whether the existing layout has a consistent logic. Done means either documenting that layout in the README or agreeing on and applying a standard structure across the project.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.