Skip to content

Latest commit

 

History

History
42 lines (30 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

42 lines (30 loc) · 1.35 KB

Contributing to Algorithms and Data Structures Course

Thank you for considering contributing to this project! Here’s how you can help:

📌 How to Contribute

  1. Fork the Repository: Start by forking this repository to your account.
  2. Clone Your Fork: 
    git clone /~https://github.com/your-username/-algorithms-and-data-structures-course.git
  3. Create a Branch: 
    git checkout -b feature/your-feature-name
  4. Make Changes: Implement your changes, add tests if necessary, and document your code.
  5. Run Tests: Make sure all tests pass.
  6. Push Changes: 
    git push origin feature/your-feature-name
  7. Create a Pull Request: Open a pull request in the original repository.

📐 Code Style

  • Use camelCase for variable and function names.
  • Include Doxygen comments in all new code for consistency in documentation.
  • Keep code simple and efficient. Optimize for readability and maintainability.

🧪 Writing Tests

All contributions should include relevant tests in the tests/ directory to ensure code correctness.

  • Use descriptive test names.
  • Test for various cases, including edge cases and error handling.

📄 Additional Information

For additional information on setup and project structure, refer to the README.md.

Thank you for helping improve this project!