Skip to content

Commit

Permalink
Tweak documentation about opening issues (exercism#415)
Browse files Browse the repository at this point in the history
We don't want people to open issues on GitHub,
we'd rather have them talk to us on the forum.
  • Loading branch information
kytrinyx authored Nov 23, 2022
1 parent 985ab43 commit 81b8406
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 6 deletions.
43 changes: 38 additions & 5 deletions building/tracks/new/request-new.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,52 @@

Please follow the instructions below to request a new Language Track.

If you wish to request a new track, **you must post in the [Support category on the Exercism Community Forum][forum-support]** to discuss this with the team.

Before opening the post, it's worth considering:
- Is it a programming language?
- Does Exercism already support the language?
- Has anyone else asked for it?
- Will you be available to actively build and launch the track?

## Is it a programming language?

At Exercism we provide a learning platform for developers who want to practice a programming language or learn a new one.

If the language is a general purpose programming language, then we'll probably be interested in having the track on Exercism.
We do not create tracks for tools, libraries, frameworks, or technologies.

## Does Exercism already support the language?

Please [check the list of track repositories](https://github.com/search?q=topic%3Aexercism-track+org%3Aexercism+fork%3Atrue&type=repositories) to find both active and inactive tracks.
Please [check the list of track repositories][track-repositories] to find both active and inactive tracks.
If you find a repository for your language, check the `active` key's value in the repository's `config.json` file for its status:

- `true`: the track is active and listed on the website's [tracks page](https://exercism.org/tracks).
- `false`: the track is inactive and not listed on the website. The track still requires work for it to become active. If you would like to help out, please open an issue on that repository to say hello.
- `true`: the track is active and listed on the website's [tracks page][exercism-tracks].
- `false`: the track is inactive and not listed on the website.
The track still requires work for it to become active.
If you'd like to help out, please open an issue on that repository to say hello.

## Has someone else asked for it?

Do a search in the [issues of the exercism/request-new-language-track repository](https://github.com/exercism/request-new-language-track/issues) for the name of the language to see if the language was already requested.
Do a search in the [issues of the generic-track repository][generic-track-repo] for the name of the language to see if the language was already requested.
Remember to check both open and closed issues.

## Will you be available to actively build and launch the track?

Exercism is a not-for-profit organization, and all the language tracks are built by volunteers.
We will only create a track if there is at least one volunteer who has offered to take the lead on building it.

The minimum to launch a track is:
- 20 practice exercises (these can be based on specifications in the [problem-specifications][problem-specifications] repository.
- Continuous integration that checks that the exercises can be solved.
- A bit of configuration and documentation.

We are available to guide you along the way, and you can also get help from the community of folks who have done this for other languages.

## It doesn't exist - I want to create it!

Awesome!! Please open a [new issue](https://github.com/exercism/request-new-language-track/issues/new), filling out the template. We will take a look!
Awesome!! Please create a new post in the [Exercism Forum][forum-support] so we can discuss the details.

[forum-support]: https://forum.exercism.org/c/support/8
[generic-track-repo]: https://github.com/exercism/generic-track/issues
[preblem-specifications]: https://github.com/exercism/problem-specifications
2 changes: 1 addition & 1 deletion using/faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ If you have spotted a typo or if you have a suggestion for clearer language or i

[mail-abuse]: mailto:abuse@exercism.org?subject=%5BCoC%5D]
[new-cli-issue]: https://github.com/exercism/CLI/issues/new
[new-language-request]: https://github.com/exercism/request-new-language-track/blob/main/README.md
[new-language-request]: https://github.com/exercism/generic-track/blob/main/README.md
[opening-an-issue]: #opening-an-issue
[overkill]: http://www.kytrinyx.com/talks/overkill
[personal-settings]: https://exercism.org/my/settings/preferences/edit
Expand Down

0 comments on commit 81b8406

Please sign in to comment.