Skip to content

Latest commit

 

History

History
77 lines (50 loc) · 3.46 KB

CONTRIBUTING.md

File metadata and controls

77 lines (50 loc) · 3.46 KB
Raw

Contributing to Learning App

Thank you for considering contributing to [Your Project Name]! We appreciate your help in making this project better.

Please take a moment to review this document to ensure a smooth and effective contribution process.

Table of Contents

  1. Code of Conduct
  2. How Can I Contribute?
  3. Development Setup
  4. Pull Request Guidelines
  5. Commit Message Guidelines
  6. Code Style
  7. License

Code of Conduct

Before we proceed, please read and adhere to our Code of Conduct. We expect all contributors to be respectful and create a welcoming environment for everyone.

How Can I Contribute?

Reporting Bugs

If you find a bug in the project, please open a GitHub issue describing the problem. Include steps to reproduce, expected behavior, and actual behavior. Be sure to check if a similar issue has already been reported.

Suggesting Enhancements

If you have an idea for an enhancement or a new feature, you can also open an issue to discuss it. Please provide as much detail as possible about the proposed change.

Code Contribution

We welcome code contributions from the community. To contribute code, follow these steps:

  1. Fork the repository to your GitHub account.
  2. Create a new branch for your contribution: git checkout -b feature/your-feature-name.
  3. Make your changes, ensuring they follow our Code Style.
  4. Write tests if applicable.
  5. Commit your changes with clear, concise messages following our Commit Message Guidelines.
  6. Push your changes to your fork: git push origin feature/your-feature-name.
  7. Create a Pull Request (PR) against the main branch of this repository.
  8. Your PR will be reviewed, and you may need to make additional changes before it is merged.

Development Setup

To set up a development environment, follow the instructions in the Development Setup document.

Pull Request Guidelines

Please adhere to the following guidelines when submitting a Pull Request:

  • Ensure that your code is well-documented and follows our Code Style.
  • Make sure all tests pass and add new tests for any new features or bug fixes.
  • Keep your PR focused on a single issue or feature. If you have multiple contributions, submit separate PRs for each.
  • Reference the related GitHub issue in your PR description.
  • Be patient during the review process, and be prepared to make changes based on feedback.

Commit Message Guidelines

  • Use clear and concise commit messages.
  • Follow the Conventional Commits format where applicable.
  • Start the message with a capitalized verb, such as "Add," "Fix," "Update," etc.

Example commit message: "Add new feature: user authentication."

Code Style

Follow the coding style and conventions used in the project. For specific coding style guidelines, refer to our Coding Style Guide.

License

By contributing to this project, you agree that your contributions will be licensed under the LICENSE of the project.

Thank you for contributing to [Your Project Name]! We value your input and look forward to working together to improve this project.