Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (66 loc) · 3.52 KB

CONTRIBUTING.md

File metadata and controls

76 lines (66 loc) · 3.52 KB

👋 Contributing to BJH OS

Getting Started

How to Contribute

Contributing via Pull Request

All contributions to BJH OS are made via Pull Requests. Follow these steps:

  1. Clone the BJH OS repository locally: 
    git clone https://github.com/Haris16-code/BJH-OS.git
  2. Create a new branch for your changes: 
    git checkout -b feature/my-new-feature
  3. Make your changes locally and test thoroughly.
  4. Push your branch to the repository: 
    git push origin feature/my-new-feature
  5. Go to the BJH OS repository on GitHub and click Compare & Pull Request.
  6. Fill out the Pull Request Template carefully, including:
    • Summary of your changes
    • Changes made
    • How to test
    • Related issues
    • Screenshots (if UI-related)
  7. Submit the pull request targeting the main branch of BJH OS.
  8. Wait for review and respond to any feedback from maintainers.
Important: Do not push directly to main. All changes must go through a pull request.

BJH OS Coding Guidelines

  • Follow the existing code style for JS, HTML, and CSS.
  • Keep code clean and well-commented.
  • Use meaningful variable and function names.
  • For UI changes, ensure the design is consistent with BJH OS.

Contributing to BJH OS Apps Market

  • Follow BJH OS coding and UI guidelines.
  • Test your app or game thoroughly.
  • Submit your project via the BJH OS Apps Deployment platform or repository.
  • Include instructions on how to use or test the app/game.
  • Read the detailed guide here: BJH OS Apps Market Guide

Learn More About Contributing on GitHub

Check out the official guide from GitHub: How to Contribute to a Project on GitHub

BJH OS Developer Documentation

For detailed developer guidelines, API documentation, and apps deployment instructions, see: BJH OS Developer Documentation

Issues

  • Before submitting a new issue, check if it already exists.
  • Use the Issue Templates (Bug Report / Feature Request) provided.
  • Provide detailed information, screenshots, and steps to reproduce bugs.
  • Submit new issues here: BJH OS Issues

Code of Conduct

By contributing, you agree to follow BJH OS’s Code of Conduct:

  • Be respectful and professional
  • Be constructive in feedback
  • No spam or offensive content

Thank You

We appreciate your contributions! BJH OS grows stronger with each contribution from the community. 🙌

List of All Contributors Who Contributed to BJH OS