You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 13, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.rst
+53-25Lines changed: 53 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,8 @@ We're pretty open about how people contribute to PyOTA, but there are a few thin
28
28
29
29
- Please do not post support requests here. Use the ``#iota-libs-pyota`` channel on `Slack`_ or post in the `forum`_ to ask for help.
30
30
- Please do not propose new API methods here. There are multiple IOTA API libraries out there, and they must all have the same functionality.
31
-
- That said, if you have an idea for a new API method, please share it on the ``#developers`` channel in `Slack`_ so that IOTA Foundation members can evaluate it!
31
+
32
+
- That said, if you have an idea for a new API method, please share it on the ``#developers`` channel in `Slack`_ so that IOTA Foundation members can evaluate it!
32
33
33
34
34
35
Need Some Inspiration?
@@ -54,29 +55,43 @@ Found a bug in the PyOTA code? Great! We can't fix bugs we don't know about; y
54
55
Instructions
55
56
------------
56
57
1. Make sure it really is a PyOTA bug.
57
-
- Check the traceback, and see if you can narrow down the cause of the bug.
58
-
- If the error is not directly caused by PyOTA, or if you are unable to figure out what is causing the problem, we're still here for for you! Post in the ``#iota-libs-pyota`` channel in `Slack`_ for assistance.
58
+
59
+
- Check the traceback, and see if you can narrow down the cause of the bug.
60
+
- If the error is not directly caused by PyOTA, or if you are unable to figure out what is causing the problem, we're still here for for you! Post in the ``#iota-libs-pyota`` channel in `Slack`_ for assistance.
61
+
59
62
2. Is it safe to publish details about this bug publicly?
60
-
- If the bug is security-related (e.g., could compromise a user's seed if exploited), or if it requires sensitive information in order to reproduce (e.g., the private key for an address), please do not post in in the PyOTA Bug Tracker!
61
-
- To report security-related bugs, please contact ``@phx`` directly in `Slack`_.
63
+
64
+
- If the bug is security-related (e.g., could compromise a user's seed if exploited), or if it requires sensitive information in order to reproduce (e.g., the private key for an address), please do not post in in the PyOTA Bug Tracker!
65
+
- To report security-related bugs, please contact ``@phx`` directly in `Slack`_.
66
+
62
67
3. Is this a known issue?
63
-
- Before posting a bug report, check the `PyOTA Bug Tracker`_ to see if there is an existing issue for this bug.
68
+
69
+
- Before posting a bug report, check the `PyOTA Bug Tracker`_ to see if there is an existing issue for this bug.
70
+
64
71
4. Create a new issue in the `PyOTA Bug Tracker`_.
65
-
- Be sure to include the following information:
66
-
- Which version of PyOTA you are using.
67
-
- Which version of Python you are using.
68
-
- Which operating system you are using.
69
-
- Instructions to reproduce the bug.
70
-
- The expected behavior, if applicable.
71
-
- The full exception traceback, if available.
72
-
- If the exception also has a context object, please include it.
72
+
73
+
- Be sure to include the following information:
74
+
75
+
- Which version of PyOTA you are using.
76
+
- Which version of Python you are using.
77
+
- Which operating system you are using.
78
+
- Instructions to reproduce the bug.
79
+
- The expected behavior, if applicable.
80
+
- The full exception traceback, if available.
81
+
- If the exception also has a context object, please include it.
82
+
73
83
5. Please be nice!
74
-
- It's frustrating when things don't work the way you expect them to. We promise we didn't put that bug in there on purpose; we're all human, and we all make mistakes sometimes.
84
+
85
+
- It's frustrating when things don't work the way you expect them to. We promise we didn't put that bug in there on purpose; we're all human, and we all make mistakes sometimes.
86
+
75
87
6. Please be patient!
76
-
- We're committed to making to making PyOTA better, but we've also got jobs and other commitments. We'll respond as soon as we can, but it might be a few days.
88
+
89
+
- We're committed to making to making PyOTA better, but we've also got jobs and other commitments. We'll respond as soon as we can, but it might be a few days.
90
+
77
91
7. Please be responsive if follow-up is needed.
78
-
- We may request additional information to help us identify/fix the bug. The faster you respond to follow-up comments in your bug report, the sooner we can squash that bug!
79
-
- If someone adds a comment to your bug report, it will appear in the `Notifications`_ page in GitHub. You can also configure GitHub to `email you`_ when a new comment is posted.
92
+
93
+
- We may request additional information to help us identify/fix the bug. The faster you respond to follow-up comments in your bug report, the sooner we can squash that bug!
94
+
- If someone adds a comment to your bug report, it will appear in the `Notifications`_ page in GitHub. You can also configure GitHub to `email you`_ when a new comment is posted.
80
95
81
96
What You Can Expect
82
97
-------------------
@@ -93,10 +108,14 @@ If you would like to contribute code to the PyOTA project, this section is for y
93
108
Instructions
94
109
------------
95
110
1. Find an issue in the `PyOTA Bug Tracker`_ to work on.
96
-
- If you want to work on a bug or feature that doesn't have a GitHub issue yet, create a new one before starting to work on it. That will give other developers an opportunity to provide feedback and/or suggest changes that will make it integrate better with the rest of the code.
111
+
112
+
- If you want to work on a bug or feature that doesn't have a GitHub issue yet, create a new one before starting to work on it. That will give other developers an opportunity to provide feedback and/or suggest changes that will make it integrate better with the rest of the code.
113
+
97
114
2. Create a fork of the PyOTA repository.
98
115
3. Create a new branch just for the bug/feature you are working on.
99
-
- If you want to work on multiple bugs/features, you can use branches to keep them separate, so that you can submit a separate Pull Request for each one.
116
+
117
+
- If you want to work on multiple bugs/features, you can use branches to keep them separate, so that you can submit a separate Pull Request for each one.
118
+
100
119
4. Once you have completed your work, create a Pull Request, ensuring that it meets the requirements listed below.
101
120
102
121
Requirements for Pull Requests
@@ -110,16 +129,24 @@ If you have any questions, please feel free to post in the ``#iota-libs-pyota``
110
129
- Please create Pull Requests against the ``develop`` branch.
111
130
- Please limit each Pull Request to a single bugfix/enhancement.
112
131
- Please limit the scope of each Pull Request to just the changes needed for that bugfix/enhancement.
113
-
- If you would like to refactor existing code, please create separate Pull Request(s) just for the refactoring.
132
+
133
+
- If you would like to refactor existing code, please create separate Pull Request(s) just for the refactoring.
134
+
114
135
- Please ensure your code works in all supported versions of Python (this includes versions of Python 2 and Python 3).
115
-
- See ``README.rst`` for the list of supported Python versions.
136
+
137
+
- See ``README.rst`` for the list of supported Python versions.
138
+
116
139
- Please ensure that your Pull Request includes full test coverage.
117
140
- Please do not introduce new dependencies unless absolutely necessary.
118
141
- When introducing new classes/functions, please write comprehensive and meaningful docstrings. It should be clear to anyone reading your code what your new class/function does and why it exists.
119
-
- Similarly, please be liberal about adding comments to your code. If you have any knowledge and/or had to do any research that would make your code easier to understand, add it as comment. Future developers will be very grateful for the extra context!
120
-
- Please ensure that your comments and docstrings use proper English grammar and spelling.
142
+
- Similarly, please be liberal about adding comments to your code. If you have any knowledge and/or had to do any research that would make your code easier to understand, add it as comment. Future developers will be very grateful for the extra context!
143
+
144
+
- Please ensure that your comments and docstrings use proper English grammar and spelling.
145
+
121
146
- Please ensure that your code conforms to `PEP-8`_.
122
-
- You may deviate from PEP-8 if you feel that your changes improve readability, but be aware that you may be asked to justify your decision.
147
+
148
+
- Much of the existing code is not currently formatted for PEP-8; where practical, you may prefer PEP-8 over being consistent with the existing code.
149
+
- We are currently converting the codebase over to PEP-8; `come on over and help us out!`_
123
150
124
151
What You Can Expect
125
152
-------------------
@@ -129,6 +156,7 @@ When you submit a Pull Request, here is what you can expect from the individual
129
156
- If any changes are needed, or if we cannot accept your submission, we will provide a respectful and constructive explanation.
130
157
131
158
159
+
.. _come on over and help us out!: https://github.com/iotaledger/iota.lib.py/issues/145
0 commit comments