Skip to content

Latest commit

 

History

History
63 lines (37 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

63 lines (37 loc) · 1.9 KB
Raw

Contributing to Potatoes

Thank you for considering contributing to Potatoes! We welcome contributions from the community to make Potatoes better.

How to Contribute

Reporting Issues

If you encounter any bugs or have suggestions for improvements, please open an issue. Be sure to include a clear description of the problem and any relevant details to help us understand and address the issue.

Contributing Code

  1. Fork the Repository

    Click the "Fork" button on the top right of this repository to create a personal copy of the project.

  2. Clone Your Fork

    git clone https://github.com/YOUR-USERNAME/potatoes-backend.git
cd potatoes-backend

  3. Create a New Branch

    Create a new branch for your changes:

    git checkout -b your-feature-branch

  4. Make Your Changes

    Implement your changes and commit them with a descriptive message:

    git add *
git commit -m "Feat: Added something" # or for fix, "Fix: something" or for Repo changes (like README changes), "Repo: something changed"

  5. Push Your Changes

    Push your branch to your forked repository:

    git push origin your-feature-branch

  6. Create a Pull Request

    Go to the Pull Requests tab of the main repository and click "New Pull Request". Provide a clear description of the changes and submit the pull request.

Code of Conduct

Please follow our Code of Conduct to ensure a welcoming and respectful environment for everyone involved.

Development Setup

For information on setting up a development environment, see our README.md and make sure you have followed all setup instructions.

Thank You!

We appreciate your contributions and look forward to working with you to make Potatoes even better!