Skip to content

Latest commit

 

History

History
65 lines (47 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

65 lines (47 loc) · 2.33 KB
Raw

Contributing to PyBrowser

Thank you for considering contributing to this project! Contributions are what make the open-source community an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue here with the following information:

  • A clear title for the issue.
  • Steps to reproduce the bug.
  • The expected behavior.
  • The actual behavior.
  • Any additional information (such as operating system, Python version, etc.) that could help us troubleshoot.

Feature Requests

If you have an idea for a new feature, feel free to suggest it by opening an issue here. Please provide:

  • A clear and concise description of the feature.
  • Why you think it would be useful.
  • Any potential implementation ideas.

Contributing Code

We welcome pull requests! Here's how you can contribute code:

  1. Fork the repository to your own GitHub account.
  2. Clone the forked repository to your local machine: 
    git clone https://github.com/kiruthikpurpose/PyBrowser.git
cd python-web-browser
  3. Create a new branch for your feature or bugfix: 
    git checkout -b feature-branch-name
  4. Make your changes, then commit and push them to your forked repository: 
    git commit -m "Description of your changes"
git push origin feature-branch-name
  5. Open a pull request from your feature branch to the main branch of this repository. In the pull request, please provide a clear description of your changes.

Code Guidelines

  • Follow Python's PEP 8 coding style guide.
  • Write meaningful commit messages that explain what your changes do.
  • Ensure that the project runs successfully before submitting your changes by testing it locally.
  • If you're adding a new feature, please include tests if possible.

Running the Project

Before submitting your pull request, please ensure the project works by running:

python main.py

Running Tests

If applicable, run tests to ensure that everything works correctly.

License

By contributing to this repository, you agree that your contributions will be licensed under the MIT License.