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
Copy file name to clipboardExpand all lines: docs/contributing.rst
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
Contributing
3
3
############
4
4
5
-
Help is always welcome and there are plenty of options how you can contribute to Solidity.
5
+
Help is always welcome and there are plenty of options to contribute to Solidity.
6
6
7
7
In particular, we appreciate support in the following areas:
8
8
@@ -22,7 +22,7 @@ To get started, you can try :ref:`building-from-source` in order to familiarize
22
22
yourself with the components of Solidity and the build process. Also, it may be
23
23
useful to become well-versed at writing smart-contracts in Solidity.
24
24
25
-
Please note that this project is released with a `Contributor Code of Conduct <https://raw.githubusercontent.com/ethereum/solidity/develop/CODE_OF_CONDUCT.md>`_. By participating in this project - in the issues, pull requests, or Gitter channels - you agree to abide by its terms.
25
+
Please note that this project is released with a `Contributor Code of Conduct <https://raw.githubusercontent.com/ethereum/solidity/develop/CODE_OF_CONDUCT.md>`_. By participating in this project — in the issues, pull requests, or Gitter channels — you agree to abide by its terms.
26
26
27
27
Team Calls
28
28
==========
@@ -49,7 +49,7 @@ reporting issues, please mention the following details:
49
49
* Actual vs. expected behaviour.
50
50
51
51
Reducing the source code that caused the issue to a bare minimum is always
52
-
very helpful and sometimes even clarifies a misunderstanding.
52
+
very helpful, and sometimes even clarifies a misunderstanding.
53
53
54
54
Workflow for Pull Requests
55
55
==========================
@@ -67,7 +67,7 @@ Additionally, if you are writing a new feature, please ensure you add appropriat
67
67
test cases under ``test/`` (see below).
68
68
69
69
However, if you are making a larger change, please consult with the `Solidity Development Gitter channel
70
-
<https://gitter.im/ethereum/solidity-dev>`_ (different from the one mentioned above, this one is
70
+
<https://gitter.im/ethereum/solidity-dev>`_ (different from the one mentioned above — this one is
71
71
focused on compiler and language development instead of language usage) first.
72
72
73
73
New features and bugfixes should be added to the ``Changelog.md`` file: please
On macOS some of the testing scripts expect GNU coreutils to be installed.
94
+
On macOS systems, some of the testing scripts expect GNU coreutils to be installed.
95
95
This can be easiest accomplished using Homebrew: ``brew install coreutils``.
96
96
97
-
On Windows systems make sure that you have a privilege to create symlinks,
97
+
On Windows systems, make sure that you have a privilege to create symlinks,
98
98
otherwise several tests may fail.
99
99
Administrators should have that privilege, but you may also
100
100
`grant it to other users <https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/create-symbolic-links#policy-management>`_
@@ -117,7 +117,7 @@ The test system automatically tries to discover the location of
117
117
the `evmone <https://github.com/ethereum/evmone/releases>`_ for running the semantic tests.
118
118
119
119
The ``evmone`` library must be located in the ``deps`` or ``deps/lib`` directory relative to the
120
-
current working directory, to its parent or its parent's parent. Alternatively an explicit location
120
+
current working directory, to its parent or its parent's parent. Alternatively, an explicit location
121
121
for the ``evmone`` shared object can be specified via the ``ETH_EVMONE`` environment variable.
122
122
123
123
``evmone`` is needed mainly for running semantic and gas tests.
@@ -292,7 +292,7 @@ Next, build Solidity (or just the ``solfuzzer`` binary) with AFL as your compile
At this stage you should be able to see a message similar to the following:
295
+
At this stage, you should be able to see a message similar to the following:
296
296
297
297
.. code-block:: text
298
298
@@ -481,7 +481,7 @@ needed for documentation and checks for any problems such as broken links or syn
481
481
Solidity Language Design
482
482
========================
483
483
484
-
To actively get involved in the language design process and share your ideas concerning the future of Solidity,
484
+
To actively get involved in the language design process and to share your ideas concerning the future of Solidity,
485
485
please join the `Solidity forum <https://forum.soliditylang.org/>`_.
486
486
487
487
The Solidity forum serves as the place to propose and discuss new language features and their implementation in
@@ -500,7 +500,7 @@ If you want to know where the team is standing in terms or implementing new feat
500
500
Issues in the design backlog need further specification and will either be discussed in a language design call or in a regular team call. You can
501
501
see the upcoming changes for the next breaking release by changing from the default branch (`develop`) to the `breaking branch <https://github.com/ethereum/solidity/tree/breaking>`_.
502
502
503
-
For ad-hoc cases and questions you can reach out to us via the `Solidity-dev Gitter channel <https://gitter.im/ethereum/solidity-dev>`_, a
503
+
For ad-hoc cases and questions, you can reach out to us via the `Solidity-dev Gitter channel <https://gitter.im/ethereum/solidity-dev>`_ — a
504
504
dedicated chatroom for conversations around the Solidity compiler and language development.
505
505
506
506
We are happy to hear your thoughts on how we can improve the language design process to be even more collaborative and transparent.
0 commit comments