|
| 1 | +# Contributing to PyTermOS |
| 2 | +Thank you for your interest in contributing to PyTermOS! We welcome contributions from anyone and are grateful for every bit of assistance. |
| 3 | + |
| 4 | +This document provides guidelines for contributing to PyTermOS. Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests. |
| 5 | + |
| 6 | +Getting Started |
| 7 | +Fork the Repository: Start by forking the PyTermOS repository on GitHub. |
| 8 | +Clone Your Fork: Clone your fork to your local machine so you can do your work. |
| 9 | +```bash |
| 10 | +git clone https://github.com/MarkPavlenko/PyTermOS.git |
| 11 | +cd PyTermOS |
| 12 | +``` |
| 13 | +Create a New Branch: For each new feature or bug fix, create a new branch based on the main branch. |
| 14 | +```bash |
| 15 | +git checkout -b feature-branch-name |
| 16 | +``` |
| 17 | +# Making Changes |
| 18 | +## Make Your Changes |
| 19 | +Add or change the code as necessary for your new feature or bug fix. |
| 20 | +## Follow the Code Style |
| 21 | +Ensure your code conforms to the existing style of the project to maintain consistency. |
| 22 | +## Write Meaningful Commit Messages |
| 23 | +Your commit messages should explain why and what your changes do. |
| 24 | +# Testing |
| 25 | +Test Your Changes: Before submitting your changes, make sure your changes do not break the existing functionality. Run any existing tests and add new ones if necessary. |
| 26 | +# Submitting Changes |
| 27 | +Push Your Changes: Push your changes to your fork on GitHub. |
| 28 | + |
| 29 | +```bash |
| 30 | +git push origin feature-branch-name |
| 31 | +``` |
| 32 | +## Submit a Pull Request |
| 33 | +Go to your fork on GitHub and click the "New pull request" button. Make sure you are requesting to pull from your branch to the main branch of the PyTermOS repository. |
| 34 | +# Code Review |
| 35 | +## Respond to Feedback |
| 36 | +If the maintainers have feedback or questions about your changes, please respond promptly and make any required updates. |
| 37 | +## Accept Criticism Gracefully |
| 38 | +Remember that the criticism from a review is about the code and not about you as a person. |
| 39 | +# Stay Involved |
| 40 | +Contributions go beyond pull requests and commits. You can really help by: |
| 41 | + |
| 42 | +### Reporting bugs. |
| 43 | +### Suggesting new features. |
| 44 | +### Writing or improving documentation. |
| 45 | +### Helping others in the community. |
| 46 | + |
| 47 | +### Thank you for your contributions! |
0 commit comments