Merge pull request #29 from rodrigo-arenas/0.6.Xdev

Contributing guides for external references

CONTRIBUTING.md

@@ -8,18 +8,22 @@ helping answer questions in issues, creating visualizations, maintaining project
 infrastructure, and creating new tests. 
 
 Code contributions are always welcome, from simple bug fixes, to new features.
-Also consider contributing to the documentation, is the easiest way to get started 
+Also consider contributing to the documentation, 
+and reviewing open issues, it is the easiest way to get started 
+
+If you have questions, you can open an issue (tag it as question).
 
 We encourage you to follow these guidelines:
 
 * Fork this project, make the changes you expect to merge and make a pull request 
-* If the working you are making is related to some issue, mention in the comments 
-  you are working on it, so other people know and no duplicate you work.
+* If the work you are making is related to some issue, please mention in the comments 
+  that you are working on it, so other people know and no duplicate you work.
 * If you are working in a new feature, or have an idea, consider first opening an issue
   so people know in what you are working on and possible give some guidelines
 * Commit all changes by pull request (PR)
 * A PR solves one problem (do not mix problems together in one PR) with the
   minimal set of changes
+* The changes should come with their respective tests and documentation
 * Describe why you are proposing those changes 
 * Please run black on top of the package to keep the formatting style
     ```bash
@@ -31,4 +35,17 @@ We encourage you to follow these guidelines:
     ```
 * We can not merge if the tests fails.
 
-Thank you for being part of this project!
+# External References
+
+We have a [file](https://github.com/rodrigo-arenas/Sklearn-genetic-opt/blob/master/docs/external_references.rst) 
+in our docs where you can put external references with the use of sklearn-genetic-opt,
+it could be a blog post, a video or an article.
+You can add the link of the content in that file (following the contribution guides).
+
+Take into consideration:
+
+* The link must be after the last existing link.
+* The name must be the title that will be visible.
+* The link must take to the referred content.
+
+## Thank you for being part of this project!

docs/external_references.rst

@@ -5,4 +5,12 @@ This external references shows some examples, tutorials or use cases
 of Sklearn-genetic-opt.
 
 
-* `Tune your Scikit-learn model using evolutionary algorithms <https://medium.com/mlearning-ai/tune-your-scikit-learn-model-using-evolutionary-algorithms-30538248ac16>`_
+* `Tune your Scikit-learn model using evolutionary algorithms <https://medium.com/mlearning-ai/tune-your-scikit-learn-model-using-evolutionary-algorithms-30538248ac16>`_
+
+
+
+Contributing
+============
+
+You can add your external reference by checking the
+`contributing guides <https://github.com/rodrigo-arenas/Sklearn-genetic-opt/blob/master/CONTRIBUTING.md>`_.