Skip to content

Latest commit

 

History

History
23 lines (19 loc) · 1.18 KB

Contributing.md

File metadata and controls

23 lines (19 loc) · 1.18 KB
Raw

First off, thanks for taking the time to contribute!The following is a set of guidelines for contributing to ERES Project, which is hosted on Github and Google Colab. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Repository Structure:

  • Independent sources
    • White Noise Analysis
    • Position of Stones
    • Photo Database
  • Genetic Algorithm
  • Encryption

How Can I Contribute?

  • To contribute please put in Pull Requests using Python and Google Colab
  • Always test your code before launching a pull request.
  • Report Bugs
  • Suggest enhancements to the code

While Suggesting Enhancements:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancements in as many details as possible.
  • Explain why this enhancement would be useful.

Note:

When submitting a pull request, please make sure your code runs without bugs/errors and it is readable.