Skip to content

Latest commit

 

History

History
47 lines (37 loc) · 3.21 KB

CONTRIBUTING.md

File metadata and controls

47 lines (37 loc) · 3.21 KB

Contributing to Endurain

Thank you for considering contributing to Endurain! Your involvement helps improve the project and ensures it remains useful for others. Below are guidelines to make your contribution process smooth and effective.

How Can You Contribute?

1. Start Small, Think Big

  • Small Contributions First: I encourage small, incremental improvements. Whether it's fixing a typo, enhancing documentation, or optimizing a small part of the code, your contribution matters. Smaller contributions are easier to review, merge, and deploy.
  • Build Up Gradually: As you familiarize yourself with the project, feel free to take on more complex tasks. However, starting small ensures that changes are manageable and can be quickly integrated.

2. Issues and Bugs

  • Report an Issue: Found a bug? Please create an issue with detailed steps to reproduce it. If you can, propose a solution or submit a pull request (PR) with the fix.
  • Fix an Issue: Browse through the list of open issues. Look for ones labeled as good first issue or help wanted if you're unsure where to start.

3. Documentation

  • Improve Documentation: Whether it's enhancing existing documentation or adding new sections, contributions to the documentation are highly valued. Clear and comprehensive documentation benefits everyone.
  • Comment Your Code: When submitting code changes, include comments where necessary. This helps maintain the code's readability and ease of understanding for future contributors.

4. Feature Requests

  • Suggest a Feature: If you have an idea for a new feature, feel free to open an issue to discuss it. Please explain the use case and how it can benefit the project.
  • Start with Discussion: Major changes or new features should be discussed in an issue before implementation. This ensures that the proposed changes align with the project goals and direction.

5. Code Quality and Testing

  • Follow Code Standards: Maintain consistency with the existing codebase. Follow any coding standards or styles used in the project.
  • Write Tests: If applicable, include tests for your changes. This helps ensure that the project remains stable and that new changes don't introduce bugs.
  • Review and Refactor: Consider reviewing and refactoring existing code to improve performance, readability, or maintainability.

Getting Started

  1. Fork the Repository: Create a fork of the project repository to work on your changes.
  2. Clone the Repository: Clone your forked repository to your local machine. 
    git clone https://github.com/joaovitoriasilva/endurain.git
  3. Create a Branch: Create a new branch for your changes. 
    git checkout -b feature/your-feature-name
  4. Make Your Changes: Commit your changes with clear and descriptive commit messages.
  5. Push Your Changes: Push your changes to your forked repository. 
    git push origin feature/your-feature-name
  6. Submit a Pull Request: Open a pull request (PR) to the main repository. Be sure to describe your changes and link to any relevant issues.

Thank You!

Your contributions, whether big or small, make a huge difference. Thank you for helping to make Endurain better!