Skip to content

Latest commit

 

History

History
100 lines (70 loc) · 3.45 KB

CONTRIBUTING.md

File metadata and controls

100 lines (70 loc) · 3.45 KB

Contributing to Newspy

Thanks for taking the time to contribute! We appreciate all contributions, from reporting bugs to implementing new features. If you're unclear on how to proceed after reading this guide, please create an issue and tag it with the question label.

Table of Contents

Reporting Bugs or Suggesting Enhancements

Before creating a bug report, please check that your bug has not already been reported, and that your bug exists on the latest version of Newspy. If you find a closed issue that seems to report the same bug you're experiencing, open a new issue and include a link to the original issue in your issue description.

Please include as many details as possible in your bug report. The information helps the maintainers resolve the issue faster.

We use GitHub issues to track bugs and suggested enhancements. You can report a bug by opening a new issue.

Contributing to the codebase

Forking the repository

Start by forking the Newspy repository, then clone your forked repository using git:

git clone [email protected]:<username>/newspy.git

cd newspy/

Picking an issue

Pick an issue by going through the issue tracker and finding an issue you would like to work on. Feel free to pick any issue that is not already assigned. We use the help wanted label to indicate issues that are high on our wishlist.

If you are a first time contributor, you might want to look for issues labeled good first issue. The Newspy code base is quite complex, so starting with a small issue will help you find your way around!

If you would like to take on an issue, please comment on the issue to let others know. You may use the issue to discuss possible solutions.

Setting up your local environment

Install the right versions of Python (3.10+) and Poetry (1.4.2+)

python --version
> Python 3.10.11 # or 3.11.5

poetry --version
> Poetry (version 1.4.2) # or higher

Install the requirements

poetry install

Install the git hook scripts

pre-commit install

Yarn install semantic-release dependencies

yarn install

Set up husky pre-commit hook

yarn husky add .husky/commit-msg 'yarn commitlint --edit $1'

License

Any contributions you make to this project will fall under the MIT License that covers the Newspy project.