Skip to content

Latest commit

 

History

History
77 lines (49 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

77 lines (49 loc) · 1.93 KB
Raw

Contributing Guidelines

Welcome to our project! We appreciate your interest in contributing. Whether you are fixing a bug, implementing a new feature, or improving documentation, your contributions are valuable.

How to Contribute

  1. Fork the Repository

    • Click on the "Fork" button on the top right corner of this repository's page.
    • Clone your forked repository to your local machine.
    git clone https://github.com/the-developer-org/create-express-lite
cd my-express-app

  2. Create a Branch

    • Create a new branch for your contribution.
    git checkout -b feature/your-feature-name

  3. Make Changes

    • Implement your changes or additions.

  4. Commit Changes

    • Commit your changes with a descriptive commit message.
    git add .
git commit -m "Add your descriptive commit message here"

  5. Push Changes

    • Push your changes to your forked repository.
    git push origin feature/your-feature-name

  6. Open a Pull Request (PR)

    • Go to your forked repository on GitHub.
    • Click on the "New Pull Request" button.
    • Provide a clear title and description for your pull request.
    • Submit the pull request.

Code Style

  • Follow the existing coding style and conventions in the project.
  • Use meaningful variable and function names.
  • Write clear and concise comments when necessary.

Testing

  • Ensure that your changes do not break existing functionality.
  • Write tests for new features or modifications.
  • Run tests before submitting a pull request.

Documentation

  • Update the README.md or other relevant documentation for your changes.

Issues and Discussions

  • Feel free to open an issue to report a bug or request a new feature.
  • Join discussions on existing issues.

License

By contributing, you agree that your contributions will be licensed under the project's MIT License.

Thank you for contributing to our project! 🚀