Skip to content
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

Closed
3 tasks done
jtigger opened this issue Nov 15, 2016 · 9 comments
Closed
3 tasks done

Comments

@jtigger
Copy link

jtigger commented Nov 15, 2016

(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:

  • extract this section into a separate file: 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).
  • optimize the main flow through the documentation for first-time contributors.
    There are some sections that describe "advanced" topics or "special case" topics; these should be yanked down in the page to avoid confusion.
  • reword/rework any hard-to-follow parts. Some sections are a little awkward or redundant.
@ErikSchierboom
Copy link
Member

As I was working on getting a local development environment setup yesterday, I'll be happy to proof-read this new document.

@MatMoore
Copy link

MatMoore commented Dec 3, 2016

Hi, I'm working on this. 👋

@MatMoore
Copy link

MatMoore commented Dec 3, 2016

I've made an attempt at the first two tasks in #3293

What do you think, @ErikSchierboom @jtigger ?

@ErikSchierboom
Copy link
Member

@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.

@jtigger
Copy link
Author

jtigger commented Dec 14, 2016

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. 🙏

jtigger added a commit that referenced this issue Dec 14, 2016
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)
@MatMoore
Copy link

@jtigger Thanks - I think it's really great that this project is so welcoming to new contributors. I'm glad I could help! 😃

@mathvesilva
Copy link

@jtigger Is there anything else that we can help? This issue is still open, but i think the work was done.

@arumoy-shome
Copy link

I think we can close this since @MatMoore has already 🚀 the extraction?

@jtigger
Copy link
Author

jtigger commented Apr 28, 2017

@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!

@jtigger jtigger closed this as completed Apr 28, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants