Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

42 lines (28 loc) · 2.9 KB

CONTRIBUTING

PRs Welcome Open Source Views OstinUA

Hello! Thank you for your interest in contributing to this project. I am always open to any help, whether it's fixing bugs, adding new features, improving documentation, or just sharing fresh ideas.

This document is not a strict set of rules, but a simple guide on how we can comfortably and productively work together. I am very friendly and will be incredibly glad for absolutely any help!

⬢ How You Can Help

  • Have a cool idea? You can create an Issue to discuss it first, or just jump straight in and open a Pull Request! Do whatever is more comfortable for you. We can always figure out the details together to make the project better.
  • Found a bug? Open an Issue and briefly describe what went wrong, or just fix it right away and send a PR.
  • Ready to write code? Feel free to fork the repository and open a Pull Request immediately. I will review it, help out if needed, and take care of the rest.
  • Improving documentation. Fixing typos, expanding instructions, or translating — absolutely any help is highly valuable.

⬢ Pull Request Process

The workflow here is as straightforward as possible:

  1. Fork this repository.
  2. Create a new branch for your changes (git checkout -b feature/my-awesome-idea or git checkout -b bugfix/issue-123).
  3. Make your changes and commit them (git commit -m "Add new awesome feature").
  4. Push the changes to your fork (git push origin feature/my-awesome-idea).
  5. Open a Pull Request to this repository.

⬢ A Few Simple Requests

  • Try to stick to the code style already used in the project.
  • Make your commit messages clear so it's easy to understand what changed.
  • If your Pull Request resolves a specific Issue, mention its number in the description (e.g., Closes #42).
  • If the logic changes, please update the relevant section in the README.

⬢ Feedback

I try to review all Issues and Pull Requests as quickly as possible. Don't worry if your code isn't perfect — I'll review it, suggest tweaks, and help merge it. If I haven't replied in a while, don't hesitate to ping me in the comments.

The main rule is mutual respect. Welcome, and thank you for your contribution!

OstinUA