Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

29 lines (18 loc) · 1.68 KB

Contributing to the Obsidian Tag Page Plugin

First off, thank you for considering contributing to this Obsidian repository! Whether you're looking to fix bugs, add new features, or simply improve the content, every contribution is appreciated.

How Can I Contribute?

  1. Reporting Bugs: If you find any bugs or issues, please create an issue in the GitHub repository with a detailed description of the problem.

  2. Suggesting Enhancements: If you have an idea for a new feature or an improvement, please create an issue describing your suggestion.

  3. Pull Requests: If you'd like to contribute directly, you can create a pull request. Please ensure that your PR has a clear description and any necessary screenshots or documentation.

Setting Up Your Environment

  1. Fork the repository.
  2. Clone your fork locally: git clone https://github.com/mjsumpter/obsidian-tag-page.git
  3. Ensure you are on the develop branch: git checkout develop
  4. Create a new branch for your changes off of develop: git checkout -b [branch-name]
  5. Make your changes and commit them: git commit -m "Describe your change here"
  6. Push your branch to GitHub: git push origin [branch-name]
  7. Create a new pull request targeting the develop branch in the main repository.

Style Guidelines

  • Commit Messages: Write clear and meaningful commit messages that describe the change and its purpose.

Review Process

After submitting a PR, a maintainer will review your contribution. They might ask for some changes or improvements before merging it into the develop branch. Please be patient and receptive to feedback. Periodically, changes from develop will be released to the main branch.