Skip to content

Latest commit

 

History

History
96 lines (67 loc) · 2.41 KB

CONTRIBUTING.md

File metadata and controls

96 lines (67 loc) · 2.41 KB
Raw

Contributing to auto-express

Thank you for considering contributing to the auto-express! We welcome contributions that help improve this project, including bug fixes, feature requests, documentation updates, and more.

How to Contribute

1. Fork the Repository

Start by forking the repository to your GitHub account.

2. Clone Your Fork

Clone the forked repository to your local machine:

git clone https://github.com/<your-username>/auto-express.git

3. Create a Branch

Create a new branch for your changes:

git checkout -b feature/your-feature-name

4. Make Changes

Make your changes or additions to the project. Ensure your code follows the project's coding style and standards.

5. Run Tests

If applicable, make sure all tests pass and write new tests for your changes:

npm run test

6. Commit Your Changes

Commit your changes with a clear and concise message:

git commit -m "Add: Description of feature or fix"

7. Push Your Changes

Push your branch to your forked repository:

git push origin feature/your-feature-name

8. Open a Pull Request

Go to the original repository and open a pull request. Provide a clear title and description of your changes.

Guidelines

Code Standards

  • Use TypeScript for all code contributions.
  • Follow the existing coding style and structure.
  • Document your code wherever applicable.

Testing

  • Ensure new features are covered with tests.
  • Do not break existing tests.

Issues

  • Before starting work, check if an issue exists for the change or feature.
  • If not, create an issue to discuss your idea before implementing it.

Communication

  • Be respectful and constructive when discussing issues or pull requests.
  • Avoid making large changes without prior discussion.

Reporting Bugs

If you find a bug, please create a new issue and include:

  • A clear and descriptive title.
  • Steps to reproduce the issue.
  • Expected and actual behavior.
  • Any relevant logs or screenshots.

Feature Requests

Have an idea for a new feature? Open a feature request issue and provide:

  • A detailed explanation of the feature.
  • How it will benefit users.
  • Any potential implementation details.

Code of Conduct

This project adheres to a Code of Conduct. By participating, you agree to abide by its rules.

Thank you for helping to improve auto-express! 💻✨