Skip to content

Commit 34dd98e

Browse files
committed
Improve CONTRIBUTING
1 parent deaea27 commit 34dd98e

File tree

1 file changed

+24
-31
lines changed

1 file changed

+24
-31
lines changed

CONTRIBUTING.rst

Lines changed: 24 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,18 @@ reports, improving documentation, submitting feature requests, reviewing
66
new submissions, or contributing code that can be incorporated into the
77
project.
88

9+
Review process
10+
--------------
11+
12+
For any **significant** changes please create a new GitHub issue and
13+
enhancements that you wish to make. Describe the feature you would like
14+
to see, why you need it, and how it will work. Discuss your ideas
15+
transparently and get community feedback before proceeding.
16+
17+
Small changes can directly be crafted and submitted to the GitHub
18+
Repository as a Pull Request. This requires creating a **repo fork** using
19+
`instruction <https://docs.github.com/en/get-started/quickstart/fork-a-repo>`_.
20+
921
Initial setup for local development
1022
-----------------------------------
1123

@@ -14,21 +26,14 @@ Install Git
1426

1527
Please follow `instruction <https://docs.github.com/en/get-started/quickstart/set-up-git>`_.
1628

17-
Create a fork
18-
~~~~~~~~~~~~~
19-
20-
If you are not a member of a development team building Data.SyncMaster, you should create a fork before making any changes.
21-
22-
Please follow `instruction <https://docs.github.com/en/get-started/quickstart/fork-a-repo>`_.
23-
2429
Clone the repo
2530
~~~~~~~~~~~~~~
2631

27-
Open terminal and run these commands:
32+
Open terminal and run these commands to clone a **forked** repo:
2833

2934
.. code:: bash
3035
31-
git clone https://github.com/MobileTeleSystems/syncmaster -b develop
36+
git clone git@github.com:myuser/syncmaster.git -b develop
3237
3338
cd syncmaster
3439
@@ -87,7 +92,7 @@ How to
8792
Run development instance locally
8893
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8994

90-
Start DB container:
95+
Start DB & RabbitMQ containers:
9196

9297
.. code:: bash
9398
@@ -237,24 +242,8 @@ If documentation should be build cleanly instead of reusing existing build resul
237242
238243
make docs-fresh
239244
240-
241-
Review process
242-
--------------
243-
244-
Please create a new GitHub issue for any significant changes and
245-
enhancements that you wish to make. Provide the feature you would like
246-
to see, why you need it, and how it will work. Discuss your ideas
247-
transparently and get community feedback before proceeding.
248-
249-
Significant Changes that you wish to contribute to the project should be
250-
discussed first in a GitHub issue that clearly outlines the changes and
251-
benefits of the feature.
252-
253-
Small Changes can directly be crafted and submitted to the GitHub
254-
Repository as a Pull Request.
255-
256245
Create pull request
257-
~~~~~~~~~~~~~~~~~~~~
246+
~~~~~~~~~~~~~~~~~~~
258247

259248
Commit your changes:
260249

@@ -271,7 +260,7 @@ After pull request is created, it get a corresponding number, e.g. 123 (``pr_num
271260
Write release notes
272261
~~~~~~~~~~~~~~~~~~~
273262

274-
Data.SyncMaster uses `towncrier <https://pypi.org/project/towncrier/>`_
263+
``Data.SyncMaster`` uses `towncrier <https://pypi.org/project/towncrier/>`_
275264
for changelog management.
276265

277266
To submit a change note about your PR, add a text file into the
@@ -286,6 +275,7 @@ combined with others, it will be a part of the "news digest"
286275
telling the readers **what changed** in a specific version of
287276
the library *since the previous version*.
288277

278+
You should also use
289279
reStructuredText syntax for highlighting code (inline or block),
290280
linking parts of the docs or external sites.
291281
If you wish to sign your change, feel free to add ``-- by
@@ -308,11 +298,10 @@ where the categories are:
308298
- ``bugfix``: A bug fix.
309299
- ``improvement``: An improvement. Improving functionality that already existed.
310300
- ``doc``: A change to the documentation.
311-
- ``dependency``: Dependency-related changes.
301+
- ``dependency``: Indicates that there have been changes in dependencies.
312302
- ``misc``: Changes internal to the repo like CI, test and build changes.
313303
- ``breaking``: introduces a breaking API change.
314304
- ``significant``: Indicates that significant changes have been made to the code.
315-
- ``dependency``: Indicates that there have been changes in dependencies.
316305

317306
A pull request may have more than one of these components, for example
318307
a code change may introduce a new feature that deprecates an old
@@ -353,7 +342,11 @@ How to skip change notes check?
353342
Just add ``ci:skip-changelog`` label to pull request.
354343

355344
Release Process
356-
^^^^^^^^^^^^^^^
345+
---------------
346+
347+
.. note::
348+
349+
This is for repo maintainers only
357350

358351
Before making a release from the ``develop`` branch, follow these steps:
359352

0 commit comments

Comments
 (0)