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 chapter on plugin development #298

Closed
alice-i-cecile opened this issue Mar 15, 2022 · 5 comments · Fixed by #848
Closed

Add chapter on plugin development #298

alice-i-cecile opened this issue Mar 15, 2022 · 5 comments · Fixed by #848

Comments

@alice-i-cecile
Copy link
Member

Begin by migrating content from https://github.com/bevyengine/bevy/blob/main/docs/plugins_guidelines.md

@TrialDragon
Copy link
Member

Past migrating the preexisting third party plugin guidelines, what should this chapter cover in it's contents?

@alice-i-cecile
Copy link
Member Author

Hmm. I think it should link to the Rust API guidelines and information about semantic versioning in Rust. CI advice is also useful.

Generic plugin types might be a good fit here too: that's a good trick that rarely comes up when making games, but is common in plugins.

@TrialDragon
Copy link
Member

Okay, what regarding CI should I look into to add? The content gotten from the guidelines already introduces an example of CI using GitHub Actions.

Also, what is the bare basics of this Generic Plugin Types in relation to third party plugins? I'm unaware of this specific context / circumstance and haven't found much info regarding this looking it up.

@TrialDragon
Copy link
Member

Another question; should this chapter be guidelines / providing direct info oriented like the third party plugin guidelines it originates from, or should it be more like a tutorial going through the process of creating a plugin in a sense providing info as it goes?

@alice-i-cecile
Copy link
Member Author

Okay, what regarding CI should I look into to add? The content gotten from the guidelines already introduces an example of CI using GitHub Actions.

For an initial PR, I'd be fine with just keeping it unmodified. Eventually, I'd like to teach a bit more about how to do CI effectively in Rust / Bevy, but that probably deserves its own dedicated chapter.

Another question; should this chapter be guidelines / providing direct info oriented like the third party plugin guidelines it originates from, or should it be more like a tutorial going through the process of creating a plugin in a sense providing info as it goes?

For now, I think we should aim for a pretty direct port: my main goal is to migrate all of the scattered documentation onto the main website, where it will actually be discoverable.

github-merge-queue bot pushed a commit to bevyengine/bevy that referenced this issue Jan 7, 2024
# Objective

- Describe the objective or issue this PR addresses.
- If you're fixing a specific issue, say "Fixes #X".

Removes the old third party plugin guidelines section and related links
since it is being moved to the Bevy book in the site per
bevyengine/bevy-website#848 and
bevyengine/bevy-website#298

## Solution

- Describe the solution used to achieve the objective above. 

Removes the old links and files.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants