Closed Greenheart closed 3 weeks ago
Hej! Jag skulle vilja hjälpa till med dokumentationen. Tack!
Definition of Done
- [ ] README.md, getting-started.md and contributing.md all include updated commands (e.g.
npm run dev
and similar) that work with the new technologies.
@Greenheart Hej! För uppgiften ovan finns kommandot npm run dev
i README.md och getting-started.md. Kan du berätta mer mig hur du vill att kommandot ska ingå i contributing.md? Tack!
Description Since we are going to use technologies that probably will be new to most contributors, we should give good instructions for how to get started. Luckily, both Astro and Svelte both have good interactive tutorials that are beginner friendly.
In addition to describing the
Motivation We need good documentation to make the Klimatkollen frontend as approachable as possible.
Definition of Done
npm run dev
and similar) that work with the new technologies../getting-started.md
to make it clear how to set up your development environment.When should it be done? The earlier we can have this in place, the easier it will be for contributors to get involved in implementing the new design. However, I will need to prioritize development in the near future, and will come back to this later. If anyone is interested in working on this issue, that would be more than welcome though! :)
Contact person @Greenheart
In addition to the Definition of Done, the following always apply: