aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2013-09-10 17:21:39 -0700
committerAlex Gaynor <alex.gaynor@gmail.com>2013-09-10 17:21:39 -0700
commit6c7be9c4f45974f907ca75f61b78a47bc3a3c6e1 (patch)
tree5a2dddb612b060ba87d32f5a7df84d7fdd4ac122
parent920e3300c3c58190f853f529c2be8e9e670f7ab5 (diff)
parent180606f3e7fd9083567e9754fca39e44b5b06b15 (diff)
downloadcryptography-6c7be9c4f45974f907ca75f61b78a47bc3a3c6e1.tar.gz
cryptography-6c7be9c4f45974f907ca75f61b78a47bc3a3c6e1.tar.bz2
cryptography-6c7be9c4f45974f907ca75f61b78a47bc3a3c6e1.zip
Merge branch 'master' into triple-des
Conflicts: tests/primitives/test_nist.py
-rw-r--r--CONTRIBUTING.rst48
-rw-r--r--docs/contributing.rst80
-rw-r--r--docs/index.rst1
-rw-r--r--tests/primitives/test_nist.py4
4 files changed, 93 insertions, 40 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 3ee89b80..9575e845 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -1,43 +1,15 @@
-Process
-=======
+Contributing to cryptography
+============================
-This repository has a mandatory code review policy. Contributions
-should happen through pull requests. Never commit to ``master``
-directly.
+As an open source project, cryptography welcomes contributions of many forms.
-Code
-====
+Examples of contributions include:
-When in doubt, refer to `PEP 8`_ for Python code.
+* Code patches
+* Documentation improvements
+* Bug reports and patch reviews
-Every code file must start with the boilerplate notice of the Apache License.
-Additionally, every Python code file must contain
+Extensive contribution guidelines are available in the repository at
+``docs/contributing.rst``, or online at:
-.. code-block:: python
-
- from __future__ import absolute_import, division, print_function
-
-Docs
-====
-
-Write docstrings like this:
-
-.. code-block:: python
-
- def some_function(some_arg):
- """
- Does some things.
-
- :param some_arg: Some argument.
- """
-
-So, specifically:
-
-- Always use three double quotes.
-- Put the three double quotes on their own line.
-- No blank line at the end.
-- Use Sphinx parameter/attribute documentation `syntax`_.
-
-
-.. _`PEP 8`: http://www.peps.io/8/
-.. _`syntax`: http://sphinx-doc.org/domains.html#info-field-lists
+https://cryptography.readthedocs.org/en/latest/contributing/
diff --git a/docs/contributing.rst b/docs/contributing.rst
new file mode 100644
index 00000000..b4c72ba4
--- /dev/null
+++ b/docs/contributing.rst
@@ -0,0 +1,80 @@
+Contributing
+============
+
+Process
+-------
+
+As an open source project, ``cryptography`` welcomes contributions of all
+forms. These can include:
+
+* Bug reports and feature requests
+* Pull requests for both code and documentation
+* Patch reviews
+
+You can file bugs and submit pull requests on `GitHub`_. To discuss larger
+changes you can start a conversation on `our mailing list`_.
+
+Because cryptography is so complex, and the implications of getting it wrong so
+devastating, ``cryptography`` has a strict code review policy:
+
+* Patches must *never* be pushed directly to ``master``, all changes (even the
+ most trivial typo fixes!) must be submitted as a pull request.
+* A committer may *never* merge their own pull request, a second party must
+ merge their changes. If multiple people work on a pull request, the merger
+ may not be any of them.
+* A patch which breaks tests, or introduces regressions by changing or removing
+ existing tests should not be merged. Tests must always be passing on
+ ``master``.
+* If somehow the tests get into a failing state on ``master`` (such as by a
+ backwards incompatible release of a dependency) no pull requests may be
+ merged until this is rectified.
+
+The purpose of these policies is to minimize the chances we merge a change
+which jeopardizes our users' security.
+
+We do not yet have a formal security contact. To report security issues in
+``cryptography`` you should email ``alex.gaynor@gmail.com``, messages may be
+encrypted with PGP to key fingerprint
+``E27D 4AA0 1651 72CB C5D2 AF2B 125F 5C67 DFE9 4084`` (this public key is
+available from most commonly-used keyservers).
+
+Code
+----
+
+When in doubt, refer to `PEP 8`_ for Python code.
+
+Every code file must start with the boilerplate notice of the Apache License.
+Additionally, every Python code file must contain
+
+.. code-block:: python
+
+ from __future__ import absolute_import, division, print_function
+
+Documentation
+-------------
+
+All features should be documented with prose.
+
+Docstrings should be written like this:
+
+.. code-block:: python
+
+ def some_function(some_arg):
+ """
+ Does some things.
+
+ :param some_arg: Some argument.
+ """
+
+So, specifically:
+
+- Always use three double quotes.
+- Put the three double quotes on their own line.
+- No blank line at the end.
+- Use Sphinx parameter/attribute documentation `syntax`_.
+
+
+.. _`GitHub`: https://github.com/alex/cryptography
+.. _`our mailing list`: https://mail.python.org/mailman/listinfo/cryptography-dev
+.. _`PEP 8`: http://www.peps.io/8/
+.. _`syntax`: http://sphinx-doc.org/domains.html#info-field-lists
diff --git a/docs/index.rst b/docs/index.rst
index 34996d7f..c8f63883 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -32,4 +32,5 @@ Contents
architecture
primitives/index
+ contributing
community
diff --git a/tests/primitives/test_nist.py b/tests/primitives/test_nist.py
index 55756682..e736d4d1 100644
--- a/tests/primitives/test_nist.py
+++ b/tests/primitives/test_nist.py
@@ -44,7 +44,7 @@ def parameterize_encrypt_test(cipher, vector_type, params, fnames):
class TestAES_CBC(object):
@parameterize_encrypt_test(
"AES", "KAT",
- ["key", "iv", "plaintext", "ciphertext"],
+ ("key", "iv", "plaintext", "ciphertext"),
[
"CBCGFSbox128.rsp",
"CBCGFSbox192.rsp",
@@ -71,7 +71,7 @@ class TestAES_CBC(object):
@parameterize_encrypt_test(
"AES", "MMT",
- ["key", "iv", "plaintext", "ciphertext"],
+ ("key", "iv", "plaintext", "ciphertext"),
[
"CBCMMT128.rsp",
"CBCMMT192.rsp",
42' href='#n442'>442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859