10h30/wordpress-export-to-markdown
1
0
Fork 0
mirror of https://github.com/10h30/wordpress-export-to-markdown.git synced 2026-06-05 15:09:59 +09:00
Code Issues Packages Projects Releases Wiki Activity

Contributing guidelines

Browse Source
This commit is contained in:
Will Boyd
2024-02-24 08:58:56 -05:00
parent 815e67f135
commit f65317713b
1 changed files with 23 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+23
View File
@@ -0,0 +1,23 @@
# How to Contribute
Contributions are welcome! Thank you!
## General Guidelines
Some quick notes when making a pull request.
- Match the style and formatting of the code you are editing.
- Each pull request should be focused on a single thing (a single bug fix, a single feature, etc.). This makes reviewing easier and minimizes merge conflicts.
- Include a description of the problem being solved and what your code does. Steps to reproduce the problem or example input/output are very helpful.
## Adding Options
Keeping the wizard as short as possible is a priority. Pull requests that add options to the wizard will probably not be accepted. Instead, you can add an advanced setting to [settings.js](https://github.com/lonekorean/wordpress-export-to-markdown/blob/master/src/settings.js).
## Adding Frontmatter Fields
Similarly, default frontmatter output is limited to just a few widely used fields to avoid bloat. However, you may add new optional frontmatter fields.
To do so, add a new `.js` file into the [/src/frontmatter](https://github.com/lonekorean/wordpress-export-to-markdown/tree/master/src/frontmatter) folder. The filename should be the name of the frontmatter field, camelcased. See the other files there for code examples.
Users will be able to include your new frontmatter field by editing `frontmatter_fields` in [settings.js](https://github.com/lonekorean/wordpress-export-to-markdown/blob/master/src/settings.js).