Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Docs to Better Explain How to Contribute and Make Sure Translate Helper Automatically Includes Changes Made #696

Merged
merged 3 commits into from
Apr 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,10 +161,20 @@ Note: On some machines the `.obsidian` folder may be hidden. On MacOS you should
1. Reload Obsidian
1. If prompted about Safe Mode, you can disable safe mode and enable the plugin.

## Contributing
## How You Can Help

Contributions are welcome, especially for new rules and new translations. If this is something you would like to do, take a look at the
[contribution guidelines](CONTRIBUTING.md).
Contributions are welcome and appreciated. You can help in any of the following ways:

No repo setup required:
- [Reporting a bug](https://github.com/platers/obsidian-linter/issues/new?assignees=&labels=bug&template=bug_report.md&title=Bug%3A+)
- [Requesting a feature](https://github.com/platers/obsidian-linter/issues/new?assignees=&labels=rule+suggestion&template=feature_request.md&title=FR%3A+)
- [Suggesting documentation](https://github.com/platers/obsidian-linter/issues/new?assignees=&labels=documentation)

Varying repo and development setup required:
- [Updating or adding documentation](https://github.com/platers/obsidian-linter/blob/master/CONTRIBUTING.md#updating-documentation)
- [Translating the plugin into a new language](https://github.com/platers/obsidian-linter/blob/master/CONTRIBUTING.md#adding-translations-for-a-language)
- [Fixing a bug](https://github.com/platers/obsidian-linter/blob/master/CONTRIBUTING.md#bug-fixes)
- [Adding a new rule](https://github.com/platers/obsidian-linter/blob/master/CONTRIBUTING.md#adding-a-rule)

## Credits

Expand Down
16 changes: 13 additions & 3 deletions docs/templates/readme_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,10 +85,20 @@ Note: On some machines the `.obsidian` folder may be hidden. On MacOS you should
1. Reload Obsidian
1. If prompted about Safe Mode, you can disable safe mode and enable the plugin.

## Contributing
## How You Can Help

Contributions are welcome, especially for new rules and new translations. If this is something you would like to do, take a look at the
[contribution guidelines](CONTRIBUTING.md).
Contributions are welcome and appreciated. You can help in any of the following ways:

No repo setup required:
- [Reporting a bug](https://github.com/platers/obsidian-linter/issues/new?assignees=&labels=bug&template=bug_report.md&title=Bug%3A+)
- [Requesting a feature](https://github.com/platers/obsidian-linter/issues/new?assignees=&labels=rule+suggestion&template=feature_request.md&title=FR%3A+)
- [Suggesting documentation](https://github.com/platers/obsidian-linter/issues/new?assignees=&labels=documentation)

Varying repo and development setup required:
- [Updating or adding documentation](https://github.com/platers/obsidian-linter/blob/master/CONTRIBUTING.md#updating-documentation)
- [Translating the plugin into a new language](https://github.com/platers/obsidian-linter/blob/master/CONTRIBUTING.md#adding-translations-for-a-language)
- [Fixing a bug](https://github.com/platers/obsidian-linter/blob/master/CONTRIBUTING.md#bug-fixes)
- [Adding a new rule](https://github.com/platers/obsidian-linter/blob/master/CONTRIBUTING.md#adding-a-rule)

## Credits

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"test": "jest",
"test-suite": "jest -t \"$1\"",
"docs": "node docs.js",
"translate": "node translation-helper.js",
"translate": "npm run build && node translation-helper.js",
"compile": "npm run build && npm run docs && npm run lint && npm run test",
"lint": "eslint . --ext .ts --fix",
"clear-jest": "jest --clearCache"
Expand Down