Updated CONTRIBUTING.md #2471
Merged
Updated CONTRIBUTING.md #2471
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jieguangzhou
force-pushed
the
doc/contribute
branch
2 times, most recently
from
fdbb747 to
bc08703
Compare
jieguangzhou
force-pushed
the
doc/contribute
branch
from
bc08703 to
0a74599
Compare
blythed
requested changes
Sep 25, 2024
| - Plugin name in `pyproject.toml` | ||
| - Package name `superduper_<PLUGIN_NAME>` | ||
| 3. Write the code for the plugin | ||
| 4. Create the tests directory `plugin_test/` and write the tests |
There was a problem hiding this comment.
Should we say something about which version number to assign to the plugin and how the releases work?
There was a problem hiding this comment.
Yes, I added a brief introduction to the CONTRIBUTING.md, but we need another page to introduce the versioning details.
CONTRIBUTING.md
Outdated
| cd superduper-docs | ||
| ``` | ||
|
|
||
| ### Updated the documentation |
There was a problem hiding this comment.
Updating the documentation
CONTRIBUTING.md
Outdated
| - Plugin documentation | ||
| - Template documentation | ||
|
|
||
| **Create or update a plugin documentation** |
There was a problem hiding this comment.
"documentation for a plugin"
CONTRIBUTING.md
Outdated
|
|
||
| **Create or update a plugin documentation** | ||
|
|
||
| After we create or update a plugin, we need to update the documentation. |
CONTRIBUTING.md
Outdated
| 1. Update the `README.md` file in the plugin directory. | ||
| 2. Copy the file to the `superduper-docs/content/plugins` directory and change the file name to `<PLUGIN_NAME>.md`. | ||
|
|
||
| **Create or update a template documentation** |
There was a problem hiding this comment.
Creating of updating documentation for a template
jieguangzhou
force-pushed
the
doc/contribute
branch
from
0a74599 to
84ce7b9
Compare
Thanks, I’ve updated it. Could you please take another look? |
jieguangzhou
force-pushed
the
doc/contribute
branch
2 times, most recently
from
2070853 to
e7eb3a2
Compare
jieguangzhou
force-pushed
the
doc/contribute
branch
from
e7eb3a2 to
84fa256
Compare
blythed
approved these changes
Sep 26, 2024
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Related Issues
Checklist
make unit_testingandmake integration-testingsuccessfully?Additional Notes or Comments