exercism/python
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Revamped README.

Browse Source
This commit is contained in:
BethanyG
2021-10-15 06:00:57 -07:00
committed by BethanyG
parent 667661ed4a
commit 3c5d643e4a
1 changed files with 68 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

104
README.md
View File

@@ -1,52 +1,84 @@
:wave: Thank you for your interest in contributing to the exercism Python track!
<br>
:warning: **Please Note** :warning:
<img align="left" width="90" height="90" src="https://github.com/exercism/website-icons/blob/main/tracks/python.svg">
<p vertical-align="middle"><h1>Exercism Python Track</h1></p>
We are currently in the middle of re-arranging and re-configuring our track for exercism V3.
We're **super-excited** :tada: :rocket: -- _and we really want you to be involved!_ -- but all that inital configuration work means **our maintainers can't accept unsolicited contributions at this time.**
Please check our [issue list](https://github.com/exercism/python/labels/help%20wanted) for tasks we've flagged as `[help wanted]` -- _and check back_ -- we'll be adding (_many more!_) tasks with that flag in the coming weeks as we update our documentation and identify exercises, documents, and bugs that need to be worked on before our V3 launch.
---
# Exercism Python Track
<br>
![Exercism_II](https://img.shields.io/badge/Exercism--Built-9101FF?logo=python&logoColor=FFDF58&labelColor=3D7AAB&label=Python-Powered)
[![Build Status](https://github.com/exercism/python/workflows/Exercises%20check/badge.svg)](https://github.com/exercism/python/actions?query=workflow%3A%22Exercises+check%22)
[![Join the chat at https://gitter.im/exercism/python](https://badges.gitter.im/exercism/python.svg)](https://gitter.im/exercism/python?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Exercism exercises in Python
<br>
Hi. &nbsp;👋🏽 &nbsp;👋 &nbsp;**We are happy you are here.**&nbsp; 🎉&nbsp;🌟
**`exercsim/Python`** is one of many programming language tracks on [exercism(dot)org][exercism-website].
This repo holds all the instructions, tests, code, & support files for Python *exercises* currently under development or implemented & available for students.
🌟 &nbsp;&nbsp;Track exercises support Python `3.8`.
🌟 &nbsp;&nbsp;Track tooling (_test-runner, representer, analyzer, and Continuous Integration_) runs on Python `3.9`.
Exercises are grouped into **concept** exercises which teach the [Python syllabus][python-syllabus], and **practice** exercises, which are unlocked by progressing in the syllabus tree &nbsp;🌴 &nbsp;. Concept exercises are constrained to a small set of language or syntax features. Practice exercises are open-ended, and can be used to practice concepts learned, try out new techniques, and _play_. These two exercise groupings can be found in the track [config.json][config-json], and under the `python/exercises` directory.
<br>
<img align="left" width="100" height="90" src="https://github.com/exercism/website-icons/blob/main/exercism/logo-big-bordered.png">
🌟🌟&nbsp; Please take a moment to read our [Code of Conduct][exercism-code-of-conduct].&nbsp;🌟🌟&nbsp;
It might also be helpful to look at [Being a Good Community Member][being-a-good-community-member] & [The words that we use][the-words-that-we-use].
Some defined roles in our community: [Contributors][exercism-contributors] **|** [Mentors][exercism-mentors] **|** [Maintainers][exercism-track-maintainers] **|** [Admins][exercism-admins]
<br>
<img align="left" width="85" height="80" src="https://github.com/exercism/website-icons/blob/main/exercises/two-fer.svg">
We&nbsp;💛&nbsp;💙 &nbsp; Pull Requests. **But our maintainers generally can't accept _unsolicited_ PRs.**
Check our [help wanted][open-issues] list or [open an issue ][open-an-issue] for discussion first.
We &nbsp;✨💙 &nbsp;💛 &nbsp;💙 ✨&nbsp; PRs that follow our **[Contributing Guidelines][contributing-guidelines]**.
## Contributing Guide
<br>
<img align="left" width="85" height="80" src="https://github.com/exercism/website-icons/blob/main/exercises/word-search.svg">
Our WIP V3 documentation can be found here: [exercism V3](https://github.com/exercism/docs).
✨&nbsp;🦄&nbsp; _**Want to jump directly into Exercism specifications & detail?**_
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Structure][exercism-track-structure] **|** [Tasks][exercism-tasks] **|** [Concepts][exercism-concepts] **|** [Concept Exercises][concept-exercises] **|** [Practice Exercises][practice-exercises] **|** [Presentation][exercise-presentation]
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Writing Style Guide][exercism-writing-style] **|** [Markdown Specification][exercism-markdown-specification] (_&nbsp;✨ &nbsp; versions available in [contributing][website-contributing-section] on [exercism(dot)org][exercism-website]._)
<br>
### Testing
If you are here to help out with [open issues][open-issues], you have our gratitude &nbsp;🙌 &nbsp;🙌🏽.
Anything with [`help wanted`] and without a [`Claimed`] tag is up for grabs - just comment, and we will reserve it for you. &nbsp;🌈 &nbsp; ✨
All exercises must be compatible with Python version 3.8 upwards. We no longer support Python 2.x.
To test a single exercise:
```
python3 test/check-exercises.py [exercise-name]
```
To test all exercises:
```
python3 test/check-exercises.py
```
### Code Style
The Python code in this repo is meant to follow the [PEP8 style guide](https://www.python.org/dev/peps/pep-0008/) (a stylized version http://pep8.org).
This repo uses [flake8](http://flake8.readthedocs.org/en/latest/) with default settings to enforce the coding standard.
### CI build
Here to suggest a new feature or new exercise?? **Hooray!** &nbsp;🎉 &nbsp;
_Please keep in mind [Chesterton's Fence][chestertons-fence]._
_Following the principals there when making your suggestions will likely result in a faster and more enthusiastic response from maintainers._
## License
This repository uses the [MIT License](/LICENSE).
[exercism-website]: https://exercism.org/
[exercise-presentation]: https://github.com/exercism/docs/blob/main/building/tracks/presentation.md
[exercism-admins]: https://github.com/exercism/docs/blob/main/community/administrators.md
[the-words-that-we-use]: https://github.com/exercism/docs/blob/main/community/good-member/words.md
[exercism-writing-style]: https://github.com/exercism/docs/blob/main/building/markdown/style-guide.md
[concept-exercises]: https://github.com/exercism/docs/blob/main/building/tracks/concept-exercises.md
[practice-exercises]: https://github.com/exercism/docs/blob/main/building/tracks/practice-exercises.md
[exercism-contributors]: https://github.com/exercism/docs/blob/main/community/contributors.md
[being-a-good-community-member]: https://github.com/exercism/docs/tree/main/community/good-member
[exercism-markdown-specification]: https://github.com/exercism/docs/blob/main/building/markdown/markdown.md
[exercism-concepts]: https://github.com/exercism/docs/blob/main/building/tracks/concepts.md
[exercism-code-of-conduct]: https://exercism.org/docs/using/legal/code-of-conduct
[config-json]: https://github.com/exercism/javascript/blob/main/config.json
[python-syllabus]: https://exercism.org/tracks/python/concepts
[exercism-track-maintainers]: https://github.com/exercism/docs/blob/main/community/maintainers.md
[exercism-tasks]: https://exercism.org/docs/building/product/tasks
[website-contributing-section]: https://exercism.org/docs/building
[exercism-track-structure]: https://github.com/exercism/docs/tree/main/building/tracks
[exercism-mentors]: https://github.com/exercism/docs/tree/main/mentoring
[open-issues]: https://github.com/exercism/python/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22
[chestertons-fence]: https://github.com/exercism/docs/blob/main/community/good-member/chestertons-fence.md
[contributing-guidelines]: https://github.com/exercism/python/blob/main/CONTRIBUTING.md
[open-an-issue]: https://github.com/exercism/python/issues/new/choose