Skip to content

Latest commit

 

History

History
61 lines (36 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

61 lines (36 loc) · 2.12 KB

Contribution guide

Thank you for considering contributing to The Passgerator! This guide will help you understand how you can contribute meaningfully to the project.

How to Contribute

  1. Report Issues: If you find a bug or have an idea for an improvement, open an issue on GitHub. Make sure you provide enough details so we can understand and reproduce the issue.

  2. Feature Requests: If you have an idea for a new feature, open an issue to discuss it before you start working on it. This ensures that the functionality is aligned with the project objectives.

  3. Submit Pull Requests: If you want to fix a bug or add new functionality, follow the steps below to submit a pull request (PR):

Sending Pull Requests

  1. Fork the Repository

Fork the repository by clicking the "Fork" button at the right side top of the GitHub page.

  1. Clone the Repository

Clone the forked repository to your local environment:

https://github.com/your-username/the-passgerator.git
cd the-passgerator
  1. Create a Branch

Create a new branch for your changes:

git checkout -b the-name-of-your-branch
  1. Make the Changes

Make the necessary changes to your local environment. Make sure you follow the project's coding style.

  1. Commit and Push

Commit your changes with a clear and concise message and make sure to add an type based on conventional commit types:

git add .
git commit -m "Clear description of what was done"
git push origin the-name-of-your-branch
  1. Open a Pull Request

Navigate to the original repository and click the "New Pull Request" button. Complete the form, ensuring you provide a clear description of what was changed and why.

Code Rules

  • Code Style: Follow the style rules defined by ESLint and Prettier.
  • Commit Messages: Use meaningful and detailed commit messages. Also remember to use conventional commit types

Contact

If you have any questions, feel free to open an issue or contact us directly.