# Contributing to bulletty
We're excited you're interested in contributing to bulletty, a TUI (Terminal User Interface) RSS/ATOM feed reader that puts data ownership back in the user's hands. As this project is under active development, your contributions are incredibly valuable.
## Reporting Bugs
If you find a bug, please check the Issues to see if it has already been reported. If not, open a new issue with a clear title and description. Include as much detail as possible to help us reproduce the issue:
- A clear and concise description of the bug.
- Steps to reproduce the behavior.
- Expected behavior.
- Your operating system and terminal emulator.
- Screenshots or a video if applicable.
## Suggesting Enhancements
We welcome all ideas for new features or improvements. If you have a suggestion, please create a new topic on the [discussions page](https://github.com/CrociDB/bulletty/discussions). Describe your idea and why you think it would be a good addition to the project.
## Submitting a Pull Request
Pull requests are the best way to get your work into the project. Please follow these steps:
1. Fork the repository and create your branch from main.
2. Clone your forked repository to your local machine.
3. Implement your changes. Please ensure your code is:
- well-written
- formatted with `cargo fmt`
- does not contain warnings
- has unit tests when applicable (library managing, feed logic, filesystem, etc)
4. Write clear, concise commit messages.
5. Push your changes to your fork.
Open a new pull request from your branch to the main branch of **bulletty**.
Provide a clear description of the changes in your pull request. If your PR addresses an existing issue, please reference it. Images and videos are always appreciated, for a quicker understanding of what has been implemented.
## Setting up Your Development Environment
To start contributing, you'll need to set up your local environment.
### Clone the repository:
```shell
git clone https://github.com/CrociDB/bulletty.git
cd bulletty
```
Follow the instructions in the project's README.md to install dependencies and run the application.
Thank you for helping us build a better bulletty!