Skip to content

Commit

Permalink
Add more instructions to contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
sjspielman committed Mar 4, 2024
1 parent ac8b7ca commit 28105ed
Showing 1 changed file with 33 additions and 2 deletions.
35 changes: 33 additions & 2 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,38 @@ Documentation is written as a series of markdown files nested by topic in direct

## Adding new documentation

_Instructions forthcoming on how to find the right place to add your docs._
As outlined in [this IA issue](https://github.com/AlexsLemonade/OpenScPCA-analysis/issues/61), we have several sections of documentation.
The diagram below shows the directory structure for the docs, for now considering only the top three directory levels.
The directory names as written in the IA issue are shown in parentheses.

Files and directories should be named with all lowercase letters using `-`, not `_`, where needed.
Each bold bullet point in the IA issue is a directory, and each plain-text bullet is a markdown file.
Consult the IA issue and this directory structure to determine where to place new markdown file.

If the IA indicates this file should be in an even more nested directory, don't worry about it for now; later, we will add additional nested directores as more documentation comes together.

Files and directories should be named with all lowercase letters and use `-`, not `_`, where needed.
**Be sure to consult the [style guide](./general-style-guide.md) when writing your documentation.**

```
├── welcome (Welcome to OpenScPCA)
│  ├── accessing-resources (Getting access to resources)
│  └── getting-started (Getting Started)
├── technical-setup (Setting up)
│   └── environment-setup (Getting access to resources)
├── communications-tools (Communicating within the Project)
│   ├── github-discussions (Github Discussions)
│   └── github-issues (Github Issues)
│   └── writing-issues (Writing good issues)
├── contributing-to-analyses (Contributing to an analysis)
│   ├── analysis-modules (Analysis modules)
│   ├── doing-analyses (Doing an analysis)
│   │   └── working-with-git (Working with git)
│   ├── planning-analyses (Planning your analysis)
│   └── pull-requests (Creating Pull Requests)
├── software-platforms (Software tools)
│   ├── aws
│   ├── docker
│   └── lsfr
└── troubleshooting-faq (Getting help & FAQ)
```

0 comments on commit 28105ed

Please sign in to comment.