Skip to main content

Contributing

I welcome contributions and feedback from the community! Here's how you can help make Periodix-Planner better.

Found a Bug?​

Before creating a new issue, please follow this process:

1. Check for Existing Issues​

Search first! Your issue may already be reported:

  1. Go to GitHub Issues

  2. Search for keywords related to your problem

  3. Check both open and closed issues

If the issue already exists:

  • 👍 Upvote it by adding a 👍 reaction to raise its priority

  • 💬 Add a comment if you have additional information or context

  • 📎 Share your specific case if it differs from the original report

Don't create duplicates! Upvoting existing issues helps prioritize better.

2. Verify You Have the Latest Version​

Before reporting, ensure you're using the latest version:

  1. Go to Settings → Community plugins

  2. Check for available updates

  3. Update the plugin if a newer version exists

  4. Test if the issue still occurs

Your issue may already be fixed in the latest release!

3. Create a New Issue​

If no existing issue matches and you're on the latest version, create a new bug report.

The bug report template will guide you through providing all necessary information:

  • Operating System (with version/build)

  • Obsidian Version

  • Plugin Version

  • Steps to reproduce

  • Expected vs actual behavior

  • Console errors/logs

  • Screenshots/videos

  • Severity level

Feature Requests​

Have an idea for a new feature? I'd love to hear it!

Before Requesting​

  1. Search existing requests - Your idea may already be proposed

  2. Upvote existing requests - Add 👍 to similar feature requests

  3. Comment on existing requests - Share your specific use case

Submit a New Feature Request​

Create a feature request using the structured template.

The feature request template will guide you through providing:

  • Feature title and problem statement

  • Proposed solution

  • Real-world use case

  • Alternatives you've considered

  • Examples/mockups

  • Priority and category

  • Willingness to contribute

Tips for Great Feature Requests:

  • ✅ Be specific: "Add ability to sort periods by creation date"

  • ❌ Too vague: "Make sorting better"

  • ✅ Explain the why: Share your workflow and how it helps

  • ❌ Just the what: Don't only describe what you want

📝 Documentation Contributions​

Help Improve the Docs​

Periodix-Planner has documentation covering features and configurations. If you spot something that's incorrect, outdated, or unclear, I'd love your help!

How you can contribute:

  • Spot an error? Create a PR to fix it

  • Found unclear explanations? Suggest improvements

  • Missing information? Add what's needed

  • Better examples? Share them

Documentation contributions are highly appreciated and help everyone in the community.

Where to contribute:

  • Documentation source is in docs-site/docs/

  • Edit pages directly on GitHub or submit a PR

  • Follow the existing style and structure

  • No contribution is too small — typo fixes are welcome!

🤝 Getting Help​

🙏 Thank You!​

Every contribution, no matter how small, makes Periodix-Planner better for everyone. Thank you for helping improve the plugin!

Ready to contribute? Fork the repository and start making improvements!