Add documentation about contributing to tracks #3232
Conversation
| * How do you run the tests? Is there a way to run all the tests for all the exercises? | ||
| * Are there any naming conventions for files or types or classes or functions? | ||
| * Is there any tooling that we're using? Linters? | ||
| * Is there continuous integration? Are there any gotchas? |
There was a problem hiding this comment.
Hints or links to resources for the language? (e.g. man test for learning conditionals in bash)
There was a problem hiding this comment.
Oooh, yes. I think that could be part of improving the exercises, same as reordering. I think maybe we should have an "As you solve exercises..." section. Things that you can think about that might cause you to improve the exercise.
There was a problem hiding this comment.
OK, I've reorganized the page a little bit, and added a section about adding hints.
| ### Porting an Exercise | ||
|
|
||
| The easiest way to add a new exercise is to find an exercise that has already been implemented in another language | ||
| track, and port it over to your target language. |
There was a problem hiding this comment.
I would be curious to see a list of the available exercises. Is https://github.com/exercism/x-common/blob/master/exercises/ the best place to start?
There was a problem hiding this comment.
Yeah, that's the complete list of exercises. It doesn't have any information about what's easy or hard, though.
We also have:
- implemented exercises: http://exercism.io/languages/bash/exercises
- unimplemented exercises: http://exercism.io/languages/bash/contribute
The UX on that last one is kind of awful, but it works. The linked documentation has more of a step-by-step thing.
|
Great initiative! I've submitted some grammar improvement PR's. Looks great to me. |
Fix broken link to languages page
Some more structure and consistency improvements
Improved consistency
|
|
||
| The goal of triaging issues is to make sure that each issue is actionable. | ||
|
|
||
| I great issue also has enough context that it could be tackled by someone who has never contributed |
There was a problem hiding this comment.
Hah. Yeah, that. Thanks :)
| # Triaging Issues in an Exercism Language Track | ||
|
|
||
| Issues need to be unambiguous and actionable. If it's hard to figure out what | ||
| an issue is about, or what to do about it, then the issue probably won't get |
There was a problem hiding this comment.
"...out what an issue is about, or what needs to be done,"
|
I'm going to go ahead and merge this. I always appreciate pull requests and further comments, so don't hesitate to have opinions later, too. |
@exercism/track-maintainers I've been working on documenting more of the work that's involved in contributing to a language track. I think that if we can get this properly documented, we can do a bit more around explicitly trying to find more people to contribute (and eventually to maintain) the tracks.
I'd love feedback about anything that catches your eye. Clarity, missing topics, correctness, whatever it is.
View the rendered files: