Skip to content

Latest commit

 

History

History
77 lines (45 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

77 lines (45 loc) · 2.19 KB

Contributing to Tutorify

We appreciate your interest in contributing to Tutorify! Here’s how you can help make the project better.

How to Contribute

Reporting Issues

If you find a bug or have a feature request, please open an issue. Make sure to include a clear description of the problem or the feature you’re requesting.

Suggesting Enhancements

If you have an idea for an enhancement or a new feature, please open an issue with a detailed description of your suggestion.

Contributing Code

To contribute code, follow these steps:

  1. Fork the Repository

    Click the "Fork" button at the top right of this repository to create your own copy.

  2. Clone Your Fork

    git clone https://github.com/Saadaan-Hassan/Tutorify.git
    cd tutorify
  3. Create a New Branch

    Create a new branch for your changes:

    git checkout -b my-new-feature
  4. Make Your Changes

    Make your changes or add new features. Ensure your code adheres to our code style guidelines.

  5. Commit Your Changes

    Commit your changes with a clear, descriptive message:

    git add .
    git commit -m "Add new feature or fix issue"
  6. Push Your Changes

    Push your changes to your fork:

    git push origin my-new-feature
  7. Open a Pull Request

    Go to the Pull Requests section of the repository and open a new pull request. Provide a clear description of your changes.

Code Style Guidelines

  • Use ESLint and Prettier for code linting and formatting.
  • Follow the existing code style and structure.
  • Write meaningful commit messages and pull request descriptions.

Documentation

If you update or add features, please ensure that the documentation in README.md is up-to-date. We also appreciate contributions to the documentation to make it clearer and more helpful.

Code of Conduct

Please follow our Code of Conduct in all interactions related to the project.

Thank you for contributing to Tutorify!