https://github.com/exercism/website-copy
A repository for exercism's website's copy
https://github.com/exercism/website-copy
community-contributions-accepted
Last synced: 4 months ago
JSON representation
A repository for exercism's website's copy
- Host: GitHub
- URL: https://github.com/exercism/website-copy
- Owner: exercism
- Created: 2017-08-08T13:34:19.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-05-20T06:25:41.000Z (about 1 year ago)
- Last Synced: 2024-05-22T16:23:40.468Z (about 1 year ago)
- Topics: community-contributions-accepted
- Language: HTML
- Homepage:
- Size: 4.7 MB
- Stars: 201
- Watchers: 27
- Forks: 952
- Open Issues: 50
-
Metadata Files:
- Readme: README.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Readme
# Copy for the Exercism website
A repository for the copy used on [Exercism's website](https://exercism.io). This repository is directly read into the site at periodic intervals.
## Contributing
Good copy and documentation is just as important as good code so we are massively grateful for contributions to this repository.
- If you find mistakes or missing information on any pages, please submit a Pull Request. You can easily do this by editing the file directly on GitHub and then following the user-interface prompts.
- If you think a new page should be added to the website, please open an Issue so that we can discuss it.
Thank you! :blue_heart:
## Mentor notes
The structure within the repository is: `/tracks/$track_id/exercises/$exercise_slug/mentoring.md`.
- You can easily edit the files within GitHub to create Pull Requests for changes.
- We'll be offering some mentors write permissions to the repo so that they can merge PRs without waiting for us to check everything.
- You'll find a button to display the Mentor Notes when you start mentoring a submission, if notes are available for that exercise.
Please use `###` for headings and try to keep to a structure of:
- **Reasonable solutions:** 1+ solutions that solve this problem well.
- **Common suggestions:** Good suggestions specific to this exercise. Good lessons that emerge from it.
- **Talking points:** Questions to challenge more advance learners with.
Here's an example for [Ruby's Isogram](https://github.com/exercism/website-copy/blob/main/tracks/ruby/exercises/isogram/mentoring.md).
This is how you create a new file:
