Skip to content
This repository has been archived by the owner on Apr 22, 2024. It is now read-only.

Add Blueprints section to the "How to Contribute" guide #1137

Merged
merged 9 commits into from
Sep 8, 2020
30 changes: 22 additions & 8 deletions docs/developer/how_to_contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ feedback is important for us to fix bugs, add new features and
make it easier to create and share Network Applications.

To give us your feedback, check the most appropriate instructions in the next
section. You can also contact us directly and subscribe to mailing lists as
described in the :doc:`/home/get_help` section.
section. You can also contact us directly on the `Slack channel`_.

Contributing Guidelines
-----------------------
Expand All @@ -20,15 +19,15 @@ Here are the guidelines we follow for different ways of contributing:
- `Want a Feature?`_
- `Want a Doc Fix?`_
- `Submission Guidelines`_
- `Blueprints`_
- `Coding Style`_
- `Signing the CLA`_

Got a Question or Problem?
--------------------------

If you have questions about how to use any component of the Kytos project,
direct them to our dev mailing list. We are also available on IRC. Check the
details in the :doc:`/home/get_help` section.
direct them to our `Slack channel`_.

.. _contributing-issue:

Expand All @@ -50,10 +49,9 @@ If you would like to implement a new feature, then consider what kind of change
it is:

- **Major Changes** that you wish to contribute to the project should be
discussed first in our dev mailing list or IRC (see: :doc:`/home/get_help`
section), so that we can better coordinate our efforts, prevent work
duplication, and help you to craft the changes so they are successfully
integrated into the project.
discussed first in our `Slack channel`_, so that we can better coordinate our
efforts, prevent work duplication, and help you craft the changes so they
are successfully integrated into the project.

- **Small Changes** can be crafted and submitted to the |repo| as Pull Requests.

Expand Down Expand Up @@ -211,6 +209,18 @@ Code contribution steps review
#. Create a new PR in GitHub
#. Respond to any code review feedback

Blueprints
----------

We have a type of document used to describe our architectural choices, called
‘blueprint’. This document is developed for our developers and records all the
main architectural decisions made in the kytos project. Blueprints are used to
specify the details of any process, resource, and anything else that is
desirable to be implemented, resulting in a major architectural change. You can
check out our blueprints to learn more about our architectural choices in the
`blueprints section`_. Remember that this document is not just for you, but
mainly for other developers.
hdiogenes marked this conversation as resolved.
Show resolved Hide resolved

Coding style
------------

Expand All @@ -235,3 +245,7 @@ must be signed. It's a quick process, we promise!
.. _GitHub repository: https://github.com/kytos/
.. _forking workflow: https://www.atlassian.com/git/tutorials/comparing-workflows#forking-workflow
.. _Google-style docstrings: https://google.github.io/styleguide/pyguide.html?showone=Comments#Comments
.. _Slack channel: https://join.slack.com/t/kytos/shared_
invite/enQtMjk0MTM0NjQwOTE1LTE2N2UyNWE2YjNjNzY0MTNiNDNiY2JmNGFlMGQxY2I5Y2IxY
jBhMTkwZjZjNDQ4Zjk3ZjExZGFjNGYzMzRjMDM
.. _blueprints section: https://github.com/kytos/kytos/tree/master/docs/blueprints