Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Source should include file list describing files and directories #2270

Closed
merriam opened this issue Oct 6, 2022 · 1 comment
Closed

Source should include file list describing files and directories #2270

merriam opened this issue Oct 6, 2022 · 1 comment

Comments

@merriam
Copy link

merriam commented Oct 6, 2022

To help attract more contributors and readers of the source code, it would be helpful to create a FileList that gives brief descriptions of the directories and files involved in the project. This gives short explanations to files outside the range of rustdoc. Creating this list saves an effort repeated by each new potential contributor.

I propose a simple text file so that people can add constructive criticism to that level. I expect it a couple days to field comments on this issue before putting in the first pull request. A later issue will add a self-contained html page.

Thank you in advance for constructive comments.

I am proposing a text file that runs about six pages:

Project Directory Tree
+  .                                                                             
+--+  .github                                                                    
+--+--+  workflows                       Configuration files for automated tasks on github.com
+--+  docs                               Druid Book in mdBook format             
+--+--+  book_examples                                                           
+--+--+--+  src                          Source of code examples included in book
+--+--+  src                             Chapters (or topics) of Druid Book      
+--+  druid                              Implementation of druid                 
+--+  druid-derive                       Implementation of derive macros         
+--+--+  src                                                                     
+--+--+  tests                                                                   
+--+--+--+  ui                                                                   
+--+  druid-shell                        Common interface for elements across platforms
...
Directory .                                                                      
    Files:
        .gitignore                       Patterns of files not to placed in git (source control)
        AUTHORS                          Partial list of copyright holders (contributors)
        Cargo.toml                       Config for Cargo (build system and package manager)
        CHANGELOG.md                     Generated changelog of latest release   
        clippy.toml                      Documented config for clippy (lint) tool
...
@xStrom
Copy link
Member

xStrom commented Nov 30, 2022

Given the conclusion of #2271 I'll close this issue as well.

@xStrom xStrom closed this as not planned Won't fix, can't repro, duplicate, stale Nov 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants