Skip to content

Latest commit

 

History

History
35 lines (22 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

35 lines (22 loc) · 2.07 KB

How to contribute to GeneticSharp

The idea behind GeneticSharp is to provide the basic and classic components that allow any programmer to quickly create a genetic algorithm using the .NET platform. Therefore, most of the basics and classic operators (crossovers, mutations, selections, reinsertions, and terminations) are implemented on it.

Having said that is not the goal of GeneticSharp to implement or provide all the possible ways to use a genetic algorithm, so, any PR that is not related to new operators, performance improvements, or bug fixing has a great chance to be rejected, but, feel free to read the contributing guidelines below and give a try.

Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one.

Did you write a fix to a bug?

  • Open a new GitHub pull request with the fix.
  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
  • Provide a code sample showing the bug happening.
  • Write a unit test that exposes the bug.

Do you intend to add a new feature or change an existing one?

  • Suggest your change in a new feature request.
  • Do not start writing code until you have collected positive feedback about the change.

Do you have questions about the source code?

  • Take a look on our wiki.
  • Ask on GeneticSharp's tag on Stack Overflow.
  • Open a question.

Do you want to contribute to the GeneticSharp documentation?

  • Please, contribute directly on our wiki.

Thanks! ❤️ ❤️ ❤️

Diego Giacomelli