Skip to main content

Contributing

We 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 us 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.

Our 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? We'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 our structured template.

Our 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

🔧 Contributing Code​

  1. Fork the repository on GitHub

  2. Clone your fork locally

  3. Create a feature branch (git checkout -b feature/amazing-feature)

  4. Make your changes and ensure they follow our coding standards

  5. Run quality checks with mise run ci to ensure everything passes

  6. Commit your changes (git commit -m 'Add amazing feature')

  7. Push to your branch (git push origin feature/amazing-feature)

  8. Open a Pull Request on GitHub

📝 Documentation Contributions​

Help Us Improve the Docs​

Periodix-Planner has documentation covering features and configurations. If you spot something that's incorrect, outdated, or unclear, we'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 with us

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!

🧪 Testing​

Before submitting code:

  1. Run tests: pnpm test
  2. Check linting: pnpm check
  3. Build the plugin: pnpm build
  4. Test manually in Obsidian

🤝 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!