raku
raku copied to clipboard
exercism
How to set up a local dev environment
See issue exercism/exercism.io#2092 for an overview of operation welcome contributors.
Provide instructions on how to contribute patches to the exercism test suites and examples: dependencies, running the tests, what gets tested on Travis-CI, etc.
The contributing document in the x-api repository describes how all the language tracks are put together, as well as details about the common metadata, and high-level information about contributing to existing problems, or adding new problems.
The README here should be language-specific, and can point to the contributing guide for more context.
From the OpenHatch guide:
Here are common elements of setting up a development environment you’ll want your guide to address:
Preparing their computer Make sure they’re familiar with their operating system’s tools, such as the terminal/command prompt. You can do this by linking to a tutorial and asking contributors to make sure they understand it. There are usually great tutorials already out there - OpenHatch’s command line tutorial can be found here. If contributors need to set up a virtual environment, access a virtual machine, or download a specific development kit, give them instructions on how to do so. List any dependencies needed to run your project, and how to install them. If there are good installation guides for those dependencies, link to them.
Downloading the source Give detailed instructions on how to download the source of the project, including common missteps or obstacles.
How to view/test changes Give instructions on how to view and test the changes they’ve made. This may vary depending on what they’ve changed, but do your best to cover common changes. This can be as simple as viewing an html document in a browser, but may be more complicated.
Installation will often differ depending on the operating system of the contributor. You will probably need to create separate instructions in various parts of your guide for Windows, Mac and Linux users. If you only want to support development on a single operating system, make sure that is clear to users, ideally in the top-level documentation.
