Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (32 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

55 lines (32 loc) · 2.3 KB

🤝 Contributing to Evolutionary Algorithms on Click

Thank you for your interest in contributing to the Evolutionary Algorithms on Click project! We are excited to collaborate with you to improve this tool.

Every contribution, no matter how small—from fixing typos to implementing new features—is welcome and valued.

🚀 Getting Started

To ensure a smooth workflow and avoid duplicate effort, please follow these steps before starting any code work.

1. Claim a Task

  • Check the project's issue tracker to find an open bug or feature to work on.
  • To get a task officially assigned to you, you must tag @Ashrockzzz2003 in a comment on the issue you wish to work on. This is required to receive assignment confirmation.

2. Set Up Your Development Environment

The complete guidelines for setting up your local environment, building, and running the application are provided in the official documentation:

👉 Application Run Guidelines

Please follow these steps to ensure the application runs correctly locally before proceeding with any code changes.

🛠 Submitting Changes (Pull Requests)

When you are ready to submit your work, please follow the standard Git workflow:

  1. Fork the repository.
  2. Clone your fork locally.
  3. Create a new branch for your feature or fix (e.g., feature/add-new-algorithm or fix/issue-42).
  4. Make your changes and commit them.
  5. Push your changes to your fork.
  6. Open a Pull Request (PR) against the main repository's main branch.

Commit Message Guidelines

  • Use a clear, descriptive title for your commits.
  • The first line of the commit message should be a brief summary (under 50 characters).
  • Reference the issue number the PR is addressing (e.g., Fix: Button layout on mobile view (#42)).

🛡 Code of Conduct

To ensure a welcoming and friendly community, we expect all contributors to follow our Code of Conduct (CoC) in all project spaces. Please read the CoC to understand the behavioral standards and reporting procedures.

❓ Need Help?

If you have any questions, need clarification on a bug, or get stuck at any point, feel free to open a new issue and ask for help! We are here to support your contribution.