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

Add Plugin Submission Documentation (Rewrite of the old) #13

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

MiguVT
Copy link

@MiguVT MiguVT commented Sep 7, 2024

As i told, i made a fast doc about submission yesterday, i took some time on my break time and made this rewrite, and not used AI for fix things, hope it helps :b

- Created a detailed guide for submitting plugins to Vencord.
- Outlined steps for forking the repository, adding a plugin, and creating a pull request.
- Included guidelines for adhering to Vencord's code structure and standards.
- Explained the review process and licensing requirements.
This commit rewrites the plugin submission guide to remove unnecessary installation instructions, clarify that plugins are first merged into the dev branch, and ensure the correct submission process. Additionally, the guide now correctly links to the Vencord community Discord and removes redundant file listings, focusing on providing clear instructions for submitting pre-made plugins.
I used my break time on my job to rewrite everything, hope it helps :b
@MiguVT
Copy link
Author

MiguVT commented Sep 7, 2024

Aditionally, i added an update section, i can delete it if wanted

Copy link

@Sqaaakoi Sqaaakoi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's very verbose regarding telling users just do [Git commands] rather than teaching the user how to use Git. Do note that this is the reason why support for userplugins is not given in support; users will follow the instructions without learning anything about the software they are using

src/content/docs/plugins/submission.md Outdated Show resolved Hide resolved
src/content/docs/plugins/submission.md Outdated Show resolved Hide resolved
src/content/docs/plugins/submission.md Outdated Show resolved Hide resolved
src/content/docs/plugins/submission.md Outdated Show resolved Hide resolved
src/content/docs/plugins/submission.md Outdated Show resolved Hide resolved
- Improve clarity and organization of the plugin submission process
- Add separate instructions for users with existing Vencord installations
- Clarify common pitfalls and best practices
- Include guidance on attaching images to GitHub issues
- Add note about git branching knowledge
@MiguVT
Copy link
Author

MiguVT commented Sep 8, 2024

Everything fixed, tysm for your comments and notes @Sqaaakoi @Sqaaakoi :b

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants