Lines Matching +full:open +full:- +full:pull +full:- +full:requests +full:- +full:limit
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.
6 propose changes to this document in a pull request.
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
32 Feature requests, bug reports, usage questions, and other issues can all be
38 Make sure you're running the latest version of Python-Markdown before reporting
42 and pull requests. GitHub's search only checks open issues by default.
49 provided as textual code blocks (screen-shots are not helpful). It may also be
53 Feature requests will often be closed with a recommendation that they be
54 implemented as third party extensions outside of the core Python-Markdown
55 library. Keeping new feature requests implemented as third party extensions
56 allows us to keep the maintenance overhead of Python-Markdown to a minimum, so
63 ## Pull Requests
65 A pull request often represents the start of a discussion, and does not
67 an issue and intend to provide a fix for it, there is no need to open an issue
68 first. You can report the issue and provide the fix together in a pull request.
70 All pull requests should be made from your personal fork of the library hosted
72 [Python-Markdown/markdown] project for pull requests. All pull requests should
74 outstanding pull request, pushing new commits to the related branch of your
75 GitHub repository will also automatically update the pull request. It may help
76 to review GitHub's documentation on [Creating a pull request from a fork].
80 GitHub's [action words] which will automatically close the issue when the pull
82 acceptable, whereas `ref #42` would not. Of course, if merging a pull request
86 Before being accepted, each pull request must include the applicable code, new
90 likely to delay any serious consideration of your pull request and may even
92 you may include a note in the pull request acknowledging that it is incomplete
95 Pull requests will generally not be accepted if any tests are failing.
96 Therefore, it is recommended that you run the tests before submitting your pull
97 request. After making a pull request, check the build status in the
100 commits to the pull request and rerun the checks.
104 In an effort to maintain consistency, Python-Markdown adheres to the following
105 style guides in its code and documentation. A pull request may be rejected if it
110 Except as noted below, all pull requests should follow Python's standard [PEP8
122 When a line of code does not fit within the line length limit, continuation
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.
158 With the exception of code blocks, limit line length to 79 characters. You may
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]:
233 Limit the first line to 72 characters or less.
235 Reference issues and pull requests liberally after the first line. Include a
238 should be found. References to issues and pull requests should only provide the
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
307 depend on the Travis server to run those tests when you submit a pull
311 However, Python-Markdown supports multiple versions of Python. Therefore, a
315 tests for the Travis server to run when a pull request is submitted, for more
324 with no arguments. See help (`tox -h`) for more options.
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
369 Bug fixes may be merged from a pull request to the `master` branch at any time
378 and/or MINOR version and set development status. Only then will any pull
379 requests implementing new features or backward incompatible changes be accepted.
382 status, a back-port of the fix should be committed to a version branch. If the
383 appropriate version branch does not exist, then it should be created and a pull
384 request back-porting the fix made against that branch. The version branch should
395 1. Verify that all outstanding issues and pull requests related to the release
406 5. Create a pull request with a commit message in the following format:
410 6. After all checks have passed, merge the pull request.
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
430 ## Issue and Pull Request Labels
432 Below are the labels used to track and manages issues and pull requests. The
437 ### Type of Issue or Pull Request
440 | ---------------------------- | ---------------- |
446 ### Category of Issue or Pull Request
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. |
469 ### Status of Pull Request
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. |
476 | `approved`{ .label .approved } | The pull request is ready to be merged. |
477 | `rejected`{ .label .rejected } | The pull request is rejected for the stated reasons. |
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 [Creating a pull request from a fork]: https://help.github.com/articles/creating-a-pull-request-fro…
486 [action words]: https://help.github.com/articles/closing-issues-using-keywords/
487 [PEP8 Style Guide]: https://www.python.org/dev/peps/pep-0008/
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
504 [Development Mode]: https://setuptools.readthedocs.io/en/latest/setuptools.html#development-mode
506 [HTML Tidy]: https://www.html-tidy.org/
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;