Skip to content

Latest commit

 

History

History
82 lines (59 loc) · 3.72 KB

CONTRIBUTING.md

File metadata and controls

82 lines (59 loc) · 3.72 KB

🌟 How to Contribute to VirtualPet

Hello, and thank you for considering contributing to this project! I am currently the sole developer of VirtualPet, and I’m excited to have your help in improving and expanding this project.

Following these guidelines will help us work effectively together and make the most out of our contributions. It also ensures a respectful and efficient process for both parties.

📎 Quick Links

🛡️ Code of Conduct

Although this is a personal project, I want to foster a respectful and collaborative environment. Please maintain a constructive and positive tone in all interactions. If you find something that could be improved, please present your ideas clearly and kindly. For more information, please visit this project's code of conduct .

🚀 Getting Started

Contributions are made via Issues and Pull Requests (PRs). Here are some basic guidelines:

  • Before opening an Issue or PR, check if there’s already a related one. This helps keep the project organized.
  • Don’t hesitate to reach out if something is unclear; I’m happy to help you understand how the project works or how to contribute.

🐞 Issues

Issues are great for:

  • Reporting bugs.
  • Proposing new features or improvements.
  • Discussing ideas before implementing changes.

When opening an Issue, please provide clear details:

  • What happens and how to reproduce the problem (if reporting a bug).
  • What you hope to achieve (if suggesting a new feature or improvement).

If you find an existing Issue that matches your problem or proposal, comment on it instead of creating a new one.

🔄 Pull Requests

PRs are how you submit changes to the project. Please ensure:

  • Each PR focuses on a single improvement or fix.
  • The title and description of the PR are clear and follow the Commit and PR Naming format.
  • You test your changes before submitting them.

Steps to contribute:

  1. Fork the repository and clone it locally.
  2. Create a new branch with a descriptive name following the Commit and PR Naming format.
  3. Make your changes and commit them with clear messages following the Commit and PR Naming format.
  4. Push your changes to your fork and open a PR in this repository.

I will review PRs and provide feedback if needed.

📝 Commit and Pull Request Naming

To maintain a clear and organized history, we use the following format for commit messages and PR titles:

ICON: [(DEV/DOC)-YYMMDDHHMM] MESSAGE

Commit Icons

  • ✨: For adding a new feature.
  • 📄: For any documentation changes.
  • 🔧: For changes in configuration files.
  • 🐛: For bug fixes.
  • 🚀: For performance improvements.
  • 🧪: For test-related changes.
  • 📦: For dependency or package changes.
  • ♻️: For code refactoring.
  • 💄: For visual or style-related changes.
  • 📝: For updating code comments.

Examples

  • ✨: [DEV-2403121234] Add achievements system
  • 📄: [DOC-2403121234] Update installation guide
  • 🐛: [DEV-2403121235] Fix authentication bug

For more options and references, see Gitmoji.

🤝 Getting Help

If you have any questions or need any guidance, please feel free to contact me directly via Issues or at acoranlol13@gmail.com. I'd be happy to work with you to improve VirtualPet.