Skip to content

Latest commit

 

History

History
76 lines (60 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

76 lines (60 loc) · 2.43 KB

Contributing to J2M 🚀

Thank you for considering contributing to J2M (JSON to Model Converter)! Your help is greatly appreciated, whether it's reporting bugs, suggesting improvements, or submitting pull requests. 🙌

🛠 How to Contribute

1️⃣ Report Bugs & Issues

If you encounter a bug or have an issue, please check the existing issues first. If your issue is new:

  • Open a new issue.
  • Provide a clear and concise description.
  • Include steps to reproduce the bug.
  • Attach screenshots or logs if applicable.

2️⃣ Suggest Features & Improvements

Have an idea for an improvement? We'd love to hear it!

3️⃣ Contribute Code (Pull Requests)

To contribute code changes, follow these steps:

Fork & Clone the Repo

# Fork the repository (via GitHub UI)
# Clone your fork
git clone https://github.com/your-username/j2m.git
cd j2m

Set Up the Project

flutter pub get
flutter run -d chrome

Create a Feature Branch

git checkout -b feature-your-feature-name

Make Your Changes

  • Follow clean coding principles.
  • Ensure code is properly documented.
  • Maintain consistency with project structure.

Commit & Push

git add .
git commit -m "feat: added new feature"
git push origin feature-your-feature-name

Open a Pull Request

  • Go to the Pull Requests page.
  • Click "New pull request".
  • Select your feature branch and compare it with main.
  • Provide a clear description of your changes.
  • Submit the pull request for review.

✅ Contribution Guidelines

  • Follow clean, readable, and maintainable code practices.
  • Keep pull requests small and focused.
  • Test your changes before submitting.
  • Use descriptive commit messages.
  • Be respectful & collaborative in discussions.

🔗 Resources & Contacts

📌 GitHub Repo: github.com/albinpk/j2m 📌 Issue Tracker: Report Issues 📌 LinkedIn: linkedin.com/in/albinpk

Happy Coding! 🚀💡