Skip to content
This repository has been archived by the owner on Jun 2, 2023. It is now read-only.

Latest commit

 

History

History
75 lines (51 loc) · 3.91 KB

controbuting.md

File metadata and controls

75 lines (51 loc) · 3.91 KB

Contributing to PythonicOS

Thank you for your interest in contributing to PythonicOS! We appreciate your support and welcome any contributions to our project.

How to contribute

There are many ways you can contribute to PythonicOS, such as:

  • Reporting issues
  • Submitting pull requests
  • Suggesting features
  • Testing the project
  • Writing documentation

Please read the following guidelines before you start contributing.

Reporting issues

If you encounter any bugs, errors, or crashes while using PythonicOS, please report them as issues on our GitHub repo. To report an issue, follow these steps:

  • Check if the issue has already been reported by searching the existing issues.
  • If the issue is not reported yet, create a new issue and fill out the issue template with the required information.
  • Provide as much detail as possible, such as the steps to reproduce the issue, the expected and actual behavior, the error messages, the screenshots, etc.
  • Be respectful and polite to other users and developers.

Submitting pull requests

If you want to fix an issue or add a feature to PythonicOS, you can submit a pull request with your code changes. To submit a pull request, follow these steps:

  • Fork the PythonicOS repo and clone it to your local machine.
  • Create a new branch for your changes and switch to it.
  • Make your changes and commit them with a clear and descriptive message.
  • Push your branch to your forked repo and create a pull request from it to the main repo.
  • Fill out the pull request template with the required information and link it to the related issue if any.
  • Wait for the code review and feedback from the maintainers.
  • Address any comments or requests for changes and update your pull request accordingly.
  • Be respectful and polite to other users and developers.

Suggesting features

If you have an idea for a new feature or an improvement for PythonicOS, you can suggest it as an issue on our GitHub repo. To suggest a feature, follow these steps:

  • Check if the feature has already been suggested by searching the existing issues.
  • If the feature is not suggested yet, create a new issue and fill out the feature request template with the required information.
  • Provide as much detail as possible, such as the motivation, use cases, benefits, drawbacks, alternatives, etc.
  • Be respectful and polite to other users and developers.

Testing the project

If you want to help us test PythonicOS and ensure its quality and stability, you can run it on your machine and report any issues or feedback. To test the project, follow these steps:

  • Download or clone the latest version of PythonicOS from our GitHub repo.
  • Follow the installation instructions in the README.md file.
  • Run PythonicOS on your machine and try out its features and functionalities.
  • Report any issues or feedback as described in the reporting issues section.

Writing documentation

If you want to help us improve the documentation of PythonicOS and make it more clear and comprehensive, you can write or edit the existing documentation files. To write documentation, follow these steps:

  • Fork the PythonicOS repo and clone it to your local machine.
  • Find the documentation file that you want to write or edit in the docs directory.
  • Write or edit the documentation using GitHub Flavored Markdown syntax.
  • Commit your changes with a clear and descriptive message.
  • Push your branch to your forked repo and create a pull request from it to the main repo.
  • Fill out the pull request template with the required information and link it to the related issue if any.
  • Wait for the code review and feedback from the maintainers.
  • Address any comments or requests for changes and update your pull request accordingly.
  • Be respectful and polite to other users and developers.

Code of conduct

Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.