Skip to content

Latest commit

 

History

History
42 lines (25 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

42 lines (25 loc) · 1.87 KB
Raw

Contributing

Deciding what to work on

  1. GitHub Issues is for our roadmap items, you are free to get started on any item there.

  2. For items that don't have a GitHub Issue, then join our Bevry Software community on Discord and discuss your proposal there.

  3. Running dorothy todos will reveal plenty of small beginner friendly tasks that can be immediately worked on, without posting a GitHub Issue.

Starting work

Install Dorothy

Fork and clone the Dorothy repository

Update Dorothy to use your fork, and create a branch for your development:

cd "$DOROTHY"
git remote add fork 'the git url of your fork'
git fetch fork
git checkout -b dev-username # or issue-1337

Developing your changes

Install all development dependencies:

dorothy dev

Visual Studio Code is recommended, as VSCode will detect Dorothy's preferences and adapt accordingly, enabling automatic correct formatting and linting as you go. When you open the Dorothy directory inside Visual Studio Code, you will get a prompt to install is recommended extensions, you should do so.

For other editors, we use Trunk Check for linting and formatting. If Trunk is not available for your setup, use shfmt and ShellCheck.

You can auto-format your changes via dorothy format, check them via dorothy check, and format and check via dorothy lint.

You can test whether or not your changes broke anything by running dorothy test.

For everything else, refer to the documentation.