Skip to content

Commit

Permalink
Giant reshuffle (sylhare#28)
Browse files Browse the repository at this point in the history
* Rearrange

* Set theme jekyll-theme-architect

* Add nav

* Move layout to the correct place

* Change theme

* Add docsify generated site

* Rename link

* Add extra sidebar

* Fix sidebars

* Fix C readme link

* Rearrange repo

* Add some basic docs

* Fixing broken links

* Update docs/concept-exercises.md

Co-Authored-By: Erik Schierboom <[email protected]>

* Update docs/concept-exercises.md

Co-Authored-By: Erik Schierboom <[email protected]>

* Update docs/concept-exercises.md

Co-Authored-By: Erik Schierboom <[email protected]>

* Fix sidebars

* Updated links

* Add maintainers info

* Add tooling sidebar

* Fix more broken links

* Add extra start to get started

* Additional link-fixes

* Additional link-fixes

* Rename content to reference

* Update repository structure

* Move exercise-shared files to separate section

* csharp: update to new structure (sylhare#1)

* csharp: create docs, reference and exercises directory

* csharp: make README and index

* csharp: renamed concept-exercises to reference

* csharp: move cli.md and debug.md to exercise/.docs directory

* csharp: add how to implement document

* csharp: update links

* csharp: add concept-exercises document

* csharp: add concept exercises

* csharp: fix invalid escaping

* csharp: fix link

* csharp: add todo for converting to Fact-based tests

* csharp: add shared file

* csharp: add new concept exercise template

* csharp: add reference to how to implement

* csharp: fix grammar

* csharp: replace duplicate information

* Fix broken links

* Add link to C# reference

* csharp: add example for new concept exercise

* csharp: example of reference

* csharp: add contributing

* csharp: add link

* csharp: update links

* csharp: add sidebar

* csharp: update sidebar

* csharp: more work

* Tweak README

* csharp: update README

* csharp: add contributing information for reference documents

* Add license

* Add GitHub information to repository structure

* Add subdivision for exercises directory in repository structure

* Update language contributing text

* Update languages/README.md

Co-Authored-By: Jeremy Walker <[email protected]>

* Update languages/README.md

Co-Authored-By: Jeremy Walker <[email protected]>

* csharp: add document for contributing to exercise-shared documents

* templates: make implement new concept exercise template generic

* Fix about

* csharp: add suggest new exercise template

* Add new concept exercise info

* templates: add placeholder brackets

* Add ask a question template

* Update ask question template

* Update markdown

* Update contributing

* csharp: update name

* Update documents

* Add links to all reference documents

* Add links to implemented files

* Add link to reference docs contributing

* Improve links

* Update links

* csharp: remove dependencies

* csharp: add more contributing

* csharp: add readme for docs

* Add links to analyzer/representer/test-runner

* csharp: update strings

* csharp: bitwise operations to fact-base

* csharp: add defaults

* csharp: convert tests to fact-based

* csharp: add sidebars

* csharp: add link

* Change V3 to v3

* Consistent casing

* csharp: change order

* Update README

* Update README.md

* Tweak things further

* More tweaks

* Fix links

* Fix typos

* Change

* csharp: rework readme

* csharp: updates

* csharp: update readme

* csharp: update word

* csharp: update

* csharp: move concepts

* Add reference doc

* Fix template links

* csharp: more work

* Simplify

* csharp: remove unused link

* csharp: remove empty row

* csharp: removing contributing

* csharp: explain

* Update README.md

* Update README.md

* Update README.md

* Add maintainers docs

* Add links

* Update C# readme

* Fix link

* Fix link

* Tweak repo structure document

* Small improvements

* csharp: fixes

* csharp: more

* Fix typo

* Add converting details

* structure: make it more clear

* Add new README and docs

* Split out readiness steps further

* Split out online editor settings further

* Tweak the repo structure docs a little

* Tweak the README for clarity

* Add new language docs

* csharp: link directly to analyzer and representer

* csharp: move concept interpretation to reference doc

* csharp: small update

* csharp: add online editor settings

* csharp: add config.json example

* csharp: more data

* Use consistent example

* Add online editor config changes

* Update README.md

Co-Authored-By: Erik Schierboom <[email protected]>

* Update README.md

Co-Authored-By: Erik Schierboom <[email protected]>

* Update docs/_sidebar.md

Co-Authored-By: Erik Schierboom <[email protected]>

* Update docs/_sidebar.md

Co-Authored-By: Erik Schierboom <[email protected]>

* Update docs/concept-exercises.md

Co-Authored-By: Erik Schierboom <[email protected]>

* Update docs/concept-exercises.md

* Update docs/maintainers/README.md

Co-Authored-By: Erik Schierboom <[email protected]>

* Apply suggestions from code review

Co-Authored-By: Erik Schierboom <[email protected]>

* Apply suggestions from code review

Co-Authored-By: Erik Schierboom <[email protected]>

* Update languages/csharp/docs/examples/new-concept-exercise-arrays.md

Co-Authored-By: Jeremy Walker <[email protected]>

* Update languages/csharp/docs/examples/new-concept-exercise-arrays.md

Co-Authored-By: Jeremy Walker <[email protected]>

* Move migrating config json file to separate file

* Add more details

* Add introduction for what maintainers actually need to do

* Update README.md

* Move things around for clarity

* Fix tons of issues

* Fix links

* Fix links

* More fixes

* Fix things more

* Revert link

* Rephrase

* Add maintainers

* update

* casing

Co-authored-by: Charles Care <[email protected]>
Co-authored-by: Erik Schierboom <[email protected]>
  • Loading branch information
3 people authored Jan 14, 2020
1 parent 03c72f5 commit c59a04a
Show file tree
Hide file tree
Showing 320 changed files with 3,170 additions and 1,444 deletions.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/ask-question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: "[ALL] Ask a question"
about: Ask a question
title: "[<LANG>] Ask a question: <SLUG>"
labels: status/help-wanted
assignees: ""
---

[Use this issue template to ask a question. Before you do though, please check the [open][issues-open] and [closed][issues-closed] issues to see if this question has already been asked or answered. If this is a new question, please fill in the issue template, and remove any sections wrapped in square brackets (such as this section!).]

[Please give as much context as possible, such as:

- The language this question applies to (e.g. Ruby).
- The exercise this question applies to (e.g. two-fer).
- If this relates to another issue, please link to that issue.
- Etc.]

[issues-open]: ./
[issues-closed]: ./?q=is%3Aissue+is%3Aclosed
104 changes: 104 additions & 0 deletions .github/ISSUE_TEMPLATE/implement-concept-exercise.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
---
name: "[MAINTAINERS] Implement new Concept Exercise"
about: FOR MAINTAINERS ONLY - Use this template to create an issue to implement a Concept Exercise
title: "[<LANG>] Implement new Concept Exercise: <SLUG>"
labels: type/new-exercise, status/help-wanted
assignees: ""
---

[Use this issue template to describe how to implement a new concept exercises. Please fill in the issue template, and remove any sections wrapped in square brackets (such as this section!).]

This issue describes how to implement the `<SLUG>` concept exercise for the <LANG> track.

## Goal

[A clear description of which concepts this exercise aims to teach.

For example:

The goal of this exercise is to teach the student how concept X is implemented in <LANG>. We will teach X through <LANG>'s Y type.]

## Things to teach

[A list of things the exercise aims to teach the student.

For example:

- Know of the existence of type `Y`.
- Know of some basic functions that work on `Y`.
- Know where `Y` is documented, or at least how to search for it.
- ...]

## Things not to teach

[A list of things that are outside the scope of this exercise and that the exercise should thus not teach.

For example:

- Memory and performance characteristics of `Y`.
- Advanced usage of `Y`.
- ...]

## Concepts

[List the concepts this exercise teaches. These concepts can be more fine-grained than their overarching concepts.

For example:

- `basic-strings`
- ...]

## Prequisites

[List the prerequisite concepts that this exercise expects the student to already be familiar with.

For example:

- `basic-numbers`
- ...]

## Resources to refer to

[List suggestions to use as resources in the exercise's documentation file(s).

For example:

### Hints

- [How to use `Y` when doing `A`][http://test.com]
- ...

### After

- [Performance characteristics of using `Y`][http://test.com]
- ...]

## Representer

[If this exercise requires any modifications to the track's representer, list these changes here and the reason for these changes.

For example:

- Normalize ternary expressions to if statements, as we are not interested in the type of conditional that is used.
- ...

To help the implementer get started, add a link to the language's representer document.]

## Analyzer

[If this exercise requires an analyzer to be added for it, list the patterns the analyzer should detect here.

For example:

- If feature `K` is used, suggest using feature `L`.
- ...

To help the implementer get started, add a link to the language's analyzer document]

## Implementing

[Please insert your track-specific implementation details here.]

## Help

If you have any questions while implementing the exercise, please post the questions as comments in this issue.
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/new-reference-doc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
name: "[MAINTAINERS] Add new reference document"
about: FOR MAINTAINERS ONLY - Use this template to create an issue to add a new reference document
title: "[<LANG>] Add new reference document: <DOC>"
labels: type/new-reference, status/help-wanted
assignees: ""
---

[Use this issue template to describe how to add a new reference doc. Only suggest adding a new reference doc when no appropriate online resource can be found. Please fill in the issue template, and remove any sections wrapped in square brackets (such as this section!).]

This issue describes how to add a new <LANG> reference document: <DOC>.

## Description

[A clear description of what information the reference document aims to teach. It should be clear how this document can help a student.

For example:

There are multiple uses of feature `X` in language `Y`. While...]

## Resources to refer to

[List additional rescources to link to from the document.

For example:

- [Other in-depth resource exploring `X`][http://test.com]
- ...]

### Contributing

[Describe the exact steps the contributor has to take to add the document.

For example:

- Create the document using ../new/master?filename=languages/&lt;lang&gt;/reference/&lt;doc&gt;.md.
- Add a link to the reference document in the reference README at ../tree/master/languages/&lt;lang&gt;/reference/readme.md.

## Help

If you have any questions while adding the reference document, please post the questions as comments in this issue.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/suggest-exercise.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: "[ALL] Suggest new exercise"
about: Suggest a new exercise
title: "[<LANG>] Suggest new exercise: <SLUG>"
labels: type/suggested-exercise, status/help-wanted
assignees: ""
---

[Use this issue template to suggest new concept exercises. Please note that we are not accepting currently suggestions for practice exercises. Please fill in the issue template, and remove any sections wrapped in square brackets (such as this section!).]

In this issue, a new concept exercise for the <LANG> track is suggested. The exercise's name is `<SLUG>`.

## Rationale

[Describe why you think this new exercise would make a good addition to the <LANG> track.]

## Concepts

[A clear description of which concepts this exercise aims to teach.

For example:

The goal of this exercise is to teach the student how concept X is implemented in <LANG>. We will teach X through <LANG>'s Y type.]
Empty file added .nojekyll
Empty file.
11 changes: 7 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
# Contributing

Know an amazing reference that explains a concept in a straight-forward way and that isn't language-heavy? Please PR it! :)
Thanks for wanting to contribute Exercism v3! Contributions are very welcome!

Seen something that we've missed or got wrong. PR a suggestion! :)
There are two ways in which to contribute:

Have we missed an extra general programming concept or paradigm? Open an issue and tell us more about where it's used.
- Contribute to a language: please first read the general [README.md][readme] and then [select the language you'd like to contribute to][languages-readme].
- Contribute to the reference documents: please read the [reference documents README][reference-readme].

Want to write a concept exercise. Please PR one!
[readme]: ./README.md
[languages-readme]: ./languages/README.md
[reference-readme]: ./reference/README.md
22 changes: 22 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
MIT License

Copyright (c) 2020 Exercism

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
© 2020 GitHub, Inc.
Loading

0 comments on commit c59a04a

Please sign in to comment.