Skip to content

Latest commit

 

History

History
108 lines (74 loc) · 3.5 KB

CONTRIBUTING.md

File metadata and controls

108 lines (74 loc) · 3.5 KB
Raw

🎉 Contributing to LinuxDroid 🚀

Welcome to LinuxDroid! We are excited that you're considering contributing to our open-source project. Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contribution you make will be greatly appreciated! 💖

Table of Contents

How to Contribute

Contributions come in many forms:

  • Reporting Bugs 🐞
  • Fixing Issues 🔧
  • Improving Documentation 📖
  • Suggesting Enhancements 💡
  • Adding New Features ✨

No contribution is too small—whether you're fixing a typo or adding a new feature, your input is always valuable.

Guidelines

Please make sure to follow these basic guidelines to keep the contributions process smooth:

1. Fork the Repository 🍴

Create your own fork of the repository by clicking the "Fork" button on GitHub.

2. Clone Your Fork 🖥️

git clone https://github.com/your-username/linuxdroid.git
cd linuxdroid

3. Create a New Branch 🌳

Create a new branch where you will make your changes:

git checkout -b my-feature-branch

4. Make Changes ✏️

Feel free to add code, fix bugs, or update documentation. Make sure to test your changes thoroughly.

5. Commit Your Changes ✅

Make sure your commit messages are clear and descriptive:

git commit -m "Add new feature: Arch Linux ARM64 support"

6. Push to Your Fork 🚀

Push your changes to your fork:

git push origin my-feature-branch

7. Submit a Pull Request (PR) 🔄

Once your changes are ready, submit a Pull Request to the main repository:

  • Go to the repository on GitHub.
  • Click on "New Pull Request."
  • Compare the changes and submit!

8. Code Review 🔍

After submitting your PR, it will be reviewed by the maintainers. Please address any feedback provided during the review process.

Code of Conduct

We follow the Contributor Covenant Code of Conduct to foster an inclusive and respectful community. Please make sure you follow these principles when contributing to the project.

Getting Started

To get started with the project:

  • Make sure you read through the project's README.md to understand its structure and purpose.
  • Check out the Issues section to find tasks or features to work on.
  • We recommend looking for issues marked with good first issue if you're new to the project.

How to Submit a Pull Request

Follow these steps to create your PR:

  • Ensure your code is well-tested: Make sure your changes are working by running them locally.
  • Follow our coding style: Consistent formatting and clean code are key to maintaining a healthy project.
  • Write detailed commit messages: Each commit should clearly explain the purpose of the changes.
  • Squash commits if necessary: Keep your commits clean and avoid unnecessary commits like "fix typo."

Thank You! 🙌

Thank you for considering contributing to LinuxDroid! We appreciate your effort and are excited to see how your contributions will make this project even better.

If you have any questions or need help, feel free to reach out. Let's build something amazing together!

Made with ❤️ by the LinuxDroid community