Skip to content

Commit

Permalink
[docs] Update folder structure in CONTRIBUTING.md (and some other fix…
Browse files Browse the repository at this point in the history
…es) (#1175)
  • Loading branch information
sikha-root authored Feb 19, 2024
1 parent 6f355ba commit f8659c2
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ There are many ways to contribute to Digger, including:
- Adding new features
- Fixing bugs
- Writing tests

- And more!
Before you start contributing, please read our [Code of Conduct](#code-of-conduct) to understand what is expected of contributors.

Before you start contributing, please read our [Code of Conduct](#code-of-conduct) to understand what is expected of contributors.

## Coding conventions

Expand All @@ -47,12 +47,11 @@ We strive to maintain a consistent coding style throughout the project. Please f
## Folder structure

```
cmd/ # contains the main cli files | TODO: refactor into cli/cmd
dockerfiles/ # DEPRECATED - contains the dockerfiles of digger | TODO: remove
libs/ # contains libraries that are common between digger cli and digger cloud backend (should NOT import anything from cli/pkg/ which is cli specific)
cli/cmd/ # contains the main cli files
cli/pkg/ # contains packages that are used by the cli code, can import from libs/
backend/ # contains the backend code, can import from libs/
docs/ # contains documentation pages
libs/ # contains libraries that are common between digger cli and digger cloud backend (should NOT import anything from pkg/ which is cli specific)
pkg/ # contains packages that are used by the cli code | TODO: refactor into cli/pkg, can import from libs/
cloud/ # (coming soon) contains the backend code, can import from libs/
```

## Submitting a pull request
Expand All @@ -74,7 +73,7 @@ When you have made changes to the codebase that you would like to contribute bac

## Release Process

**NOTE: The default branch `@develop` is not guaranteed to be stable and you should always use published release versions in your testing and production.**
**NOTE: The default branch `@develop` is not guaranteed to be stable and you should always use published release versions in your testing and production environments.**

- All pull requests are merged to the default develop branch after initial unit tests and integration tests are passing and required code review requirements are met.
- We checkout a pre-release branch to prepare for an upcoming release with the pattern `prerelease-0.1.xx`.
Expand Down

0 comments on commit f8659c2

Please sign in to comment.