saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Merge pull request #31658 from rallytime/add-style-to-contrib

Browse source 
Add mentioned of Salt's Coding Style docs to the Contributing docs
This commit is contained in:
Mike Place 2016-03-03 15:14:57 -07:00
commit bd04c964d1
2 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
doc/topics/development/contributing.rst
View file

@ -13,6 +13,21 @@ There are a number of ways to contribute to Salt development.
For details on how to contribute documentation improvements please review
:ref:`Writing Salt Documentation <salt-docs>`.
Salt Coding Style
-----------------
SaltStack has its own coding style guide that informs contributors on various coding
approaches. Please review the :ref:`Salt Coding Style<coding-style>`_ documentation
for information about Salt's particular coding patterns.
Within the :ref:`Salt Coding Style<coding-style>`_ documentation, there is a section
about running Salt's ``.pylintrc`` file. SaltStack recommends running the ``.pylintrc``
file on any files you are changing with your code contribution before submitting a
pull request to Salt's repository. Please see the :ref:`Linting<pylint-instructions>`_
documentation for more information.
.. _github-pull-request:
Sending a GitHub pull request

4
doc/topics/development/conventions/style.rst
View file

@ -1,3 +1,5 @@
.. _coding-style:
=================
Salt Coding Style
=================
@ -15,6 +17,8 @@ no grounds to treat others without respect, especially people working to
improve Salt)!!
.. _pylint-instructions:
Linting
=======