Skip to content

Latest commit

 

History

History
134 lines (87 loc) · 3.81 KB

CONTRIBUTING.md

File metadata and controls

134 lines (87 loc) · 3.81 KB

🤝 Contributing to Opera GX Docs

Thank you for considering contributing to Opera GX Docs! 🎉 Your contributions help improve our documentation, extensions, and mods for the Opera GX community.

🛠 How to Contribute

1. Fork the Repository

Click the "Fork" button on the top right corner of the repository page. This will create a personal copy of the repository under your GitHub account.

2. Clone the Forked Repository

Clone your forked repository to your local machine:

git clone https://github.com/nexoscreator/opera-gx-docs.git
cd opera-gx-docs

3. Create a New Branch

Create a new branch for your feature or bug fix:

git checkout -b feature/YourFeatureName

Example:

git checkout -b feature/add-dark-mode

4. Make Your Changes

Modify the files you want to update or add new content.

  • For Docs, update files in docs/
  • For Mods, add/update files in mods/
  • For Extensions, modify files in extensions/

5. Commit Your Changes

Add and commit your changes with a meaningful commit message:

git add .
git commit -m "✨ Added dark mode support"

6. Push Your Changes

Push your branch to GitHub:

git push origin feature/YourFeatureName

7. Open a Pull Request (PR)

  • Go to the original repository on GitHub.
  • Click on the "New Pull Request" button.
  • Select the branch you pushed and compare it with main or dev branch.
  • Provide a clear title and description for your PR.
  • Click "Create Pull Request".

📌 Your PR will be reviewed, and feedback may be given. Make sure to address any requested changes.

📌 Contribution Guidelines

Do’s

✔️ Follow the branch naming convention: feature/your-feature-name or fix/bug-description
✔️ Keep commits small and atomic (one change per commit)
✔️ Write clear and meaningful commit messages
✔️ Use proper indentation and coding style
✔️ Test your changes before submitting a PR
✔️ Add documentation if applicable

Don’ts

❌ Don’t commit unnecessary files (e.g., node_modules, .env)
❌ Don’t make multiple changes in a single PR
❌ Don’t merge your own PR without review
❌ Don’t spam PRs (e.g., empty or irrelevant PRs)

📖 Documentation Guidelines

  • Keep explanations clear and concise.
  • Use proper Markdown formatting (# Headings, **Bold Text**, - Lists, etc.).
  • Ensure links are valid and point to the correct pages.

🎭 Mod Development Guidelines

  • Follow Opera GX’s modding standards.
  • Ensure assets (images, sounds, effects) are optimized.
  • Add descriptive names for mod files and resources.

🔌 Extension Development Guidelines

  • Follow Opera GX Extension APIs & security guidelines.
  • Ensure cross-browser compatibility (where applicable).
  • Maintain performance efficiency to avoid lag in Opera GX.

💡 Issue Reporting & Feature Requests

If you find a bug or have a feature request, please open an issue:

  1. Go to the Issues tab.
  2. Click "New Issue".
  3. Choose Bug Report or Feature Request template.
  4. Provide a detailed description, steps to reproduce, and expected behavior.

🔧 Code of Conduct

By participating, you agree to follow our Code of Conduct. We aim to create an inclusive, welcoming environment for all contributors.

🌟 Need Help?

If you have any questions or need help, feel free to:

❤️ Thank You for Your Contribution!

Your contributions make Opera GX Docs better for everyone! 🚀