Skip to content

Latest commit

 

History

History
94 lines (61 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

94 lines (61 loc) · 2.49 KB

Contributing to Stream Reader 📚

We’re excited that you’re interested in contributing to Stream Reader! This guide will help you get started.

How to Contribute

1. Report Issues

If you find a bug, have a question, or want to suggest a new feature:

  • Search Existing Issues: Check the Issues tab to see if your concern has already been addressed.
  • Create a New Issue: If not, open a new issue. Please provide:
    • A clear and descriptive title.
    • Detailed steps to reproduce the issue (if applicable).
    • Suggestions or ideas (if applicable).

2. Fork the Repository

Please, take a look at Contributing to a project - GitHub Docs page for more in-detail informations.

  • Go to the repository page.
  • Click the Fork button.
  • Clone your fork to your local machine:
git clone https://github.com/your-username/stream-reader.git

3. Create a Branch

To make changes:

  • Navigate to your cloned repository:
cd stream-reader
  • Create and switch to a new branch:
git checkout -b feature/your-feature-name
# or
git checkout -b fix/your-fix-name
# or
git checkout -b doc/your-doc-improvements

4. Make Changes

Keep changes relevant to your branch’s purpose.

5. Commit Changes

This repository requires signed commit, so please before continuing, take a look at Signing Commits - GitHub Docs.

  • Stage your changes:
git add .
  • Write a meaningful commit message:
git commit -m "Add feature/bug-fix description"

6. Push to Your Fork

Push your branch to your forked repository:

git push origin feature/your-feature-name

7. Submit a Pull Request

  • Navigate to your forked repository on GitHub.
  • Click the Pull Request button.
  • Select the base repository and compare across forks.
  • Add a detailed description explaining your changes.

Code of Conduct

By participating in this project, you agree to follow our Code of Conduct.

Review Process

Pull requests will be reviewed by maintainers. Feedback may be provided; be prepared to make changes if requested. Once approved, your contribution will be merged into the main branch.

Thank you for helping improve Stream Reader! 🎉