Lines Matching +full:aspell +full:- +full:en
1 # Contributing to Python-Markdown
3 The following is a set of guidelines for contributing to Python-Markdown and its
4 extensions, which are hosted in the [Python-Markdown Organization] on GitHub.
11 [Python-Markdown Code of Conduct]. By participating, you are expected to uphold
16 The core Python-Markdown code base and any built-in extensions are hosted in the
17 [Python-Markdown/markdown] project on GitHub. Other extensions maintained by the
18 Python-Markdown project may be hosted as separate repositories in the
19 [Python-Markdown Organization] on GitHub and must follow best practices for
20 third-party extensions.
22 The [Python-Markdown/markdown] project is organized as follows:
24 * Branch `master` should generally be stable and release-ready at all times.
25 * Version branches should be used for bug-fixes back-ported to the most recent
38 Make sure you're running the latest version of Python-Markdown before reporting
49 provided as textual code blocks (screen-shots are not helpful). It may also be
54 implemented as third party extensions outside of the core Python-Markdown
56 allows us to keep the maintenance overhead of Python-Markdown to a minimum, so
72 [Python-Markdown/markdown] project for pull requests. All pull requests should
104 In an effort to maintain consistency, Python-Markdown adheres to the following
128 of the line that starts the multi-line construct.
141 When the conditional part of an `if`-statement is long enough to require that it
154 should be simple, plain, objective and well-balanced where possible.
193 Here is a link to [some other thing][other-thing].
197 [other-thing]: http://example.com/other/thing
202 If you are linking to another document within Python-Markdown's documentation,
219 Python-Markdown's [Admonition Extension]:
244 To start developing on Python-Markdown is it best to create a [fork] of the
283 pip install --editable .
292 python -m markdown
298 python -m unittest discover tests
311 However, Python-Markdown supports multiple versions of Python. Therefore, a
324 with no arguments. See help (`tox -h`) for more options.
333 Finally, the `spellchecker` environment requires [aspell] and the
334 `aspell-en` dictionary to be installed. Unfortunately, installing those
340 Python-Markdown provides [test tools] which simply testing Markdown syntax.
346 Python-Markdown follows [Semantic Versioning] and uses the
362 At all other times, the code is considered stable and release-ready.
364 MAJOR and MINOR releases may or may not get pre-releases (alpha, beta, release
382 status, a back-port of the fix should be committed to a version branch. If the
384 request back-porting the fix made against that branch. The version branch should
413 [Python-Markdown/markdown] repository. The new tag should trigger a GitHub
420 - Deploy the release to [PyPI] with the command `make deploy`.
422 - Deploy an update to the documentation using [MkDocs]. The following example
423 assumes that local clones of the [Python-Markdown/markdown] and
424 [Python-Markdown/Python-Markdown.github.io] repositories are in sibling
425 directories named `markdown` and `Python-Markdown.github.io` respectively.
427 cd Python-Markdown.github.io
428 mkdocs gh-deploy --config-file ../markdown/mkdocs.yml --remote-branch master
440 | ---------------------------- | ---------------- |
449 | -------------------------------- | ---------------------------------------- |
457 | --------------------------------------- | --------------------------------- |
458 | `more-info-needed`{ .label .pending } | More information needs to be provided. |
459 | `needs-confirmation`{ .label .pending } | The alleged behavior needs to be confirmed. |
460 | `needs-decision`{ .label .pending } | A decision needs to be made regarding request. |
462 | `someday-maybe`{ .label .low } | Approved **low priority** request. |
466 | `3rd-party`{ .label .rejected } | Should be implemented as a third party extension. |
472 | ------------------------------------- | ----------------------------------- |
473 | `work-in-progress`{ .label .pending } | A partial solution. More changes will be coming. |
474 | `needs-review`{ .label .pending } | Needs to be reviewed and/or approved. |
475 | `requires-changes`{ .label .pending } | Awaiting updates after a review. |
479 [Python-Markdown Organization]: https://github.com/Python-Markdown
480 [Python-Markdown Code of Conduct]: https://github.com/Python-Markdown/markdown/blob/master/CODE_OF_…
481 [Python-Markdown/markdown]: https://github.com/Python-Markdown/markdown
482 [issue tracker]: https://github.com/Python-Markdown/markdown/issues
485 … a pull request from a fork]: https://help.github.com/articles/creating-a-pull-request-from-a-fork/
486 [action words]: https://help.github.com/articles/closing-issues-using-keywords/
487 [PEP8 Style Guide]: https://www.python.org/dev/peps/pep-0008/
488 [Flake8]: http://flake8.pycqa.org/en/latest/index.html
490 [docs directory]: https://github.com/Python-Markdown/markdown/tree/master/docs
498 [fork]: https://help.github.com/articles/about-forks
499 [cloning your fork]: https://help.github.com/articles/cloning-a-repository/
500 [configure a remote]: https://help.github.com/articles/configuring-a-remote-for-a-fork
501 [sync changes]: https://help.github.com/articles/syncing-a-fork
502 [virtual environment]: https://virtualenv.pypa.io/en/stable/
503 [User Guide]: https://virtualenv.pypa.io/en/stable/user_guide.html
504 [Development Mode]: https://setuptools.readthedocs.io/en/latest/setuptools.html#development-mode
506 [HTML Tidy]: https://www.html-tidy.org/
507 [tox]: https://tox.readthedocs.io/en/latest/
508 [aspell]: http://aspell.net/
511 [markdown/__meta__.py]: https://github.com/Python-Markdown/markdown/blob/master/markdown/__meta__.p…
512 [PEP 440]: https://www.python.org/dev/peps/pep-0440/
514 [Python-Markdown/Python-Markdown.github.io]: https://github.com/Python-Markdown/Python-Markdown.git…
521 font-weight: 600;
522 line-height: 15px;
523 display: inline-block;
527 background-color: #c45b46;
530 background-color: #7b17d8;
534 background-color: #efbe62;
537 background-color: #eec9ff;
540 background-color: #0b02e1;
544 background-color: #709ad8;
547 background-color: #b2ffeb;
550 background-color: #beed6d;
553 background-color: #dddddd;
556 background-color: #f0f49a;
559 background-color: #f7c7be;