First off, thanks for taking the time to contribute! ❤️
I want to …
- report a bug! -> open an issue
- fix a bug! -> open a pull request
- implement a new feature! -> open an issue to discuss it first, then a pull request
- add an exercise! -> read this
- update an outdated exercise! -> open a pull request
You can open an issue here. If you're reporting a bug, please include the output of the following commands:
py --versionls -la- Your OS name and version
You are welcome to open a pull request, but unless it is small and trivial, please open an issue to discuss your idea first
Opening a pull request is as easy as forking the repository and committing your changes. If you need any help with it or face any Git related problems, don't hesitate to ask for help
It may take time to review your pull request. Please be patient
When updating an exercise, check if its solution needs to be updated.
- Name the file
exercises/yourTopic/yourTopicN.rs. - Make sure to put in some helpful links, and link to sections of The Book in
exercises/yourTopic/README.md. - In the exercise, add a
// TODO: …comment where user changes are required. - Copy
exercises/yourTopic/yourTopicN.rstobackups/yourTopic/yourTopicN.rs - Add a solution at
solutions/yourTopic/yourTopicN.rswith comments explaining it. - Add the metadata for your exercise in the
pylings/config/config.tomlfile. - Make sure your exercise runs
- Open a pull request.
The exercise metadata should contain the following, and be in sorted list:
[exercises]
name = "yourTopicN"
dir = "yourTopic"
hint = """
Multiline is supported
This is more readable than using \n on one continous line
""""