Skip to content

Latest commit

 

History

History
65 lines (49 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

65 lines (49 loc) · 1.76 KB
Raw

Contributing to News Collector in Python

First off, thank you for considering contributing to my project! Your contributions are greatly appreciated.

How Can You Contribute?

There are several ways to contribute to this project:

  • Reporting bugs
  • Suggesting new features
  • Improving documentation
  • Writing code (new features, bug fixes, refactoring)
  • Reviewing pull requests

Getting Started

Fork the Repository

  1. Fork the repository by clicking the "Fork" button at the top right of the repository page.
  2. Clone your fork: 
    git clone https://github.com/your_username/news-collector.git
  3. Navigate to the project directory: 
    cd news-collector

Set Up Your Local Environment

  1. Install the required packages: 
    pip install -r requirements.txt
  2. Create a branch for your feature or bug fix: 
    git checkout -b feature/your_feature_name

Making Changes

  1. Make your changes in your branch.
  2. Test your changes to ensure they work as expected.
  3. Commit your changes with a clear and concise commit message: 
    git commit -m "Description of your changes"

Submitting Your Changes

  1. Push your changes to your forked repository: 
    git push origin feature/your_feature_name
  2. Open a pull request to the main repository:
    • Go to the main repository on GitHub.
    • Click the "Pull Request" button.
    • Select your branch and click "Create Pull Request".
  3. Provide a detailed description of your changes in the pull request.

Code of Conduct

This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to me.

Thank you for contributing!