contributing.rst

############
Contributing
############
The AboutCode organization welcomes you and your interest in contributing to our
organization. We are always looking for enthusiatic contributors and we are willing to
lend a helping hand if you have any questions or comments. That being said, here a few
resources to help you get started.

*  Take a look through our public repos here: https://github.com/nexB/ .
      1) Find one you are interested in and check out its open **Issues**.
*  If you have specific questions browse through our documentation here: https://aboutcode.readthedocs.io/en/latest/ .
      1) Depending on the project, there may be a seperate ReadTheDocs website.
      2) If you did not find what you were looking for or you still have questions,
      open an issue on the relevant repository, or ask directly via Gitter.

*   You can always interact with the AboutCode organization and our extended community on Gitter_

                .. _Gitter: https://gitter.im/aboutcode-org/discuss


  

 ###############
   TESTING
 ###############
   
*   You've written and tested your code, but before sending code out for review, run all the tests for the whole tree to make sure the changes don't break other           
    packages or programs.

*    After running for a while and printing a lot of testing output, the command should finish by printing,

     ALL TESTS PASSED


*    In the  (https://github.com/nexB/, For Example) repositories
     Run the tests for the entire repository.

*    If you're concerned about the build status, you can check the Build Dashboard. Test failures may also be caught  in code review.

*    Some repositories will have different testing infrastructures, so always check the documentation for the repository in which you are working The README file in the
     root of the repository will usually have this information.