contributing.md

Contributing to AeroSaver

Thank you for your interest in contributing to AeroSaver, a flight price prediction project! We appreciate your help in improving the project.

Steps to run this application in your system and start contributing:

1. Clone or download the repo.

2. Open the folder in VS Code.

3. Install all the dependencies:

pip install -r requirements.txt

4. Run the application

python app.py

Contribution Guidelines

Reporting Issues

• Before opening an issue, check if one already exists.
• Provide a clear and detailed description of the issue.
• Include logs, screenshots, or examples if applicable.

Feature Requests

• Suggest new features by opening an issue.
• Provide a detailed use case and reasoning.

Code Contributions

1. Follow Coding Standards:

   • Use meaningful commit messages.
   • Maintain proper indentation and formatting.

2. To start contributing make sure to create a new branch and then, start working

   git checkout -b your-username-feature-name
   

3. Commit and Push:

   git add .
   git commit -m "Description of your changes"
   git push origin your-branch-name
   

4. Open a Pull Request (PR) to the main branch:

   • Go to the original repository and click "New Pull Request."
   • Ensure your PR is raised against the main branch.
   • Provide a clear title and description.
   • Link to the related issue if applicable.

Code of Conduct

Be respectful, inclusive, and helpful in all interactions. We welcome all contributions and encourage collaboration.

Contact

For any questions, reach out via issues or discussions.

Happy coding! 🚀