Skip to content

Latest commit

 

History

History
75 lines (55 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

75 lines (55 loc) · 2.82 KB
Raw

Contributing to Prodigy-InfoTech

Thank you for considering contributing to Prodigy-InfoTech! We welcome contributions of all kinds and appreciate your help in improving our project. Please take a moment to review this guide to ensure a smooth process for everyone involved.

How to Contribute

Reporting Issues

If you find a bug or have a feature request, please open an issue on GitHub. Before opening a new issue, please search the existing issues to see if it has already been reported or discussed.

  1. Navigate to the Issues section.
  2. Click on New Issue.
  3. Provide a clear and descriptive title for the issue.
  4. Fill out the issue template with as much detail as possible.

Submitting Pull Requests

  1. Fork the repository to your GitHub account.
  2. Clone your forked repository to your local machine: 
    git clone https://github.com/yashksaini-coder/Prodigy-InfoTech
  3. Create a new branch for your feature or bug fix: 
    git checkout -b feature/your-feature-name
  4. Make your changes in your local repository.
  5. Commit your changes with a clear and concise commit message: 
    git commit -m "Add feature/fix description"
  6. Push your changes to your forked repository: 
    git push origin feature/your-feature-name
  7. Open a Pull Request to the main repository:
    • Go to the original repository and navigate to the Pull Requests tab.
    • Click on New Pull Request.
    • Select your branch from the head repository.
    • Provide a clear and detailed description of your changes.
    • Click on Create Pull Request.

Development Guidelines

Setting Up the Development Environment

  1. Ensure you have Python and pip installed.
  2. Install the required dependencies: 
    pip install -r requirements.txt

Coding Standards

Please adhere to the following coding standards:

  • Follow PEP 8 for Python code.
  • Write clear, concise, and self-documenting code.
  • Include docstrings for all public methods and classes.
  • Write tests for new features and bug fixes.
  • Ensure your code passes all tests before submitting a pull request.

Community and Support

For discussions, questions, or support, please use the following channels:

License

By contributing to Prodigy-InfoTech, you agree that your contributions will be licensed under the MIT License.

Feel free to adjust any details to better fit the specifics of your repository or project workflow.