Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
111 lines (73 loc) · 2.83 KB

CONTRIBUTING.md

File metadata and controls

111 lines (73 loc) · 2.83 KB

🙌 Contributing to JavaFX Markdown Preview

First off, thanks for taking the time to contribute! 🎉
Contributions are what make the open-source community such an amazing place to learn, inspire, and create.

Whether it's fixing a bug, adding a new feature, improving documentation, or suggesting enhancements—your help is appreciated!

🚀 How to Contribute

1. Fork the Repository

Click the Fork button at the top-right corner of this page to create your own copy.

2. Clone Your Fork

git clone https://github.com/your-username/javafx-markdown-preview.git

cd javafx-markdown-preview

3. Create a New Branch

git checkout -b your-feature-name
  • 💡 Tip: Use descriptive branch names like fix-live-refresh, add-theme-support, etc.

4. Make Your Changes

  • Make your edits to the code, documentation, or tests.

5. Commit and Push

git add .

git commit -m "✨ Add new feature: ..."

git push origin your-feature-name

6. Open a Pull Request

  • Go to the Pull Requests tab in the GitHub repo.

  • Click "New pull request".

  • Set the base branch to main and compare it with your feature branch.

  • Add a meaningful title and description.

✅ Code Guidelines

  • Follow standard Java code formatting.

  • Use clear commit messages.

  • Add JavaDoc comments where necessary.

  • Include example usage if you're adding a new public method.

  • Ensure your code doesn't break existing examples.

🧪 Running Examples

  • Test your changes using the sample files under the examples/ folder.
  • If adding a new feature, please consider adding a demo for it too.

🛠️ Reporting Issues

  • Found a bug or have a feature suggestion?

  1. Go to the Issues section.

  2. Click New Issue.

  3. Fill out the issue template with steps to reproduce or describe your suggestion clearly.

  4. Add screenshots if applicable.

🙏 Thank You

Thanks again for your interest and support in making JavaFX Markdown Preview better! Let’s build something awesome together.

— @raghul-tech