taskwarrior icon indicating copy to clipboard operation
taskwarrior copied to clipboard

Use a codespace and simplify the "getting started contributing" docs

Open djmitche opened this issue 2 years ago • 5 comments

Let's make sure that GitHub codespaces can support building Taskwarrior, and then update the getting-started docs to suggest that approach, rather than installing the toolchains locally.

This will be a good issue to start with if you've used GitHub codespaces before and are familiar with how they are set up.

djmitche avatar Jul 16 '23 21:07 djmitche

I'm all for documenting codespaces but not sure why you'd want to make that the recommended development environment straightaway. Is local installation really so painful?

ryneeverett avatar Jul 17 '23 15:07 ryneeverett

We'll definitely keep the local installation instructions, but the trend is toward automated development environments and I suspect we'll get more casual code contributions if contributors can do it quickly and harmlessly in the browser. And, getting more people involved in hacking on Taskwarrior is pretty important to the health of the project!

djmitche avatar Jul 17 '23 21:07 djmitche

It seemed like a good learning opportunity, so I futzed around with it and just submitted #3144 to add the devcontainer / codespace config. If that looks good, I can contribute relevant instructions to the developer docs.

dathanb avatar Jul 18 '23 06:07 dathanb

I presume these instructions should be added to doc/devel/contrib/development.md?

Would the following be sufficient:

  • Brief explanation on creating a new Codespaces instance with a link to the GitHub docs.
  • Callout that you can create a local devcontainer as well if you meet the system requirements, with a link to the Development Containers spec.

hugginsio avatar Jan 31 '24 23:01 hugginsio

Ideally this would be descriptive enough that someone new to GitHub codespaces could be up-and-running without reading a lot of docs from GitHub.

We want to enable easy drive-by contributions, so someone who knows either C++ or Rust, but not both, should see 3-4 simple steps to get up and building/testing Taskwarrior having modified code in the language they know.

djmitche avatar Feb 01 '24 23:02 djmitche