-
-
Notifications
You must be signed in to change notification settings - Fork 1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Extract "How to Setup a Local Development Environment" from CONTRIBUTING.md #3251
Comments
As I was working on getting a local development environment setup yesterday, I'll be happy to proof-read this new document. |
Hi, I'm working on this. 👋 |
I've made an attempt at the first two tasks in #3293 What do you think, @ErikSchierboom @jtigger ? |
@MatMoore Looks very promising! I've added some comments to your PR, mostly some styling and I'd like to also include instructions for the Windows platform. |
Hey @MatMoore, I've been out sick and just getting back into the swing of things. So delighted that you picked this up! Thank you for doing this work. Every bit the we smooth out the road for contributors means it's that much easier for all those people who come behind you to get going. Also, there are a number of paths through which people will arrive at the need to setup a local install; by pulling it out, you've made that easier to find/reference. 🙏 |
Minor tweaks to #3251, all aiming to continue to smooth the ride. - be explicit about versions of dependencies. - rely on package managers for installing software. - ... (this is WIP)
@jtigger Thanks - I think it's really great that this project is so welcoming to new contributors. I'm glad I could help! 😃 |
@jtigger Is there anything else that we can help? This issue is still open, but i think the work was done. |
I think we can close this since @MatMoore has already 🚀 the extraction? |
@mathvesilva: @arumoy-shome is right, we can close this particular issue. However, there's a raft of documentation-oriented work over in the new doc repo: https://github.com/exercism/docs/issues If you're still game to contribute in that way, we'd love it! |
(part of a larger effort to overhaul documentation around contributing: exercism/discussions#73)
CONTRIBUTING.md#setup describes how to setup a local development environment.
In order to support making it easier to reference this block of instructions and to make it easier for them to follow:
docs/setting-up-local-development.md
(please use that name, other work (e.g. Add self-directed help section to CONTRIBUTING.md #3194) is aiming to reference it).There are some sections that describe "advanced" topics or "special case" topics; these should be yanked down in the page to avoid confusion.
The text was updated successfully, but these errors were encountered: