morrisonak / nexliber-projects

🚀 The Project Library of NexLiber

Guide for Creators

Thank you for your interest in becoming a Creator! Follow the steps below to start your journey with NexLiber!

Fork This Repository

Since you do not have write access to xyntechx/NexLiber-Projects, you have to fork this repository before creating a pull request with the project you have in mind. Follow GitHub's official guide here to learn how you can fork a repository.

Add Your Project

Here are the step-by-step instructions you should follow:

• Put all the files and folders of your complete working project into one main overarching folder
• Add a README.md file to the root directory of the main folder - follow the format of this template
• Name the main folder your Project Title (e.g. Free Scrabble)
• Place the main folder into the root directory of your fork
• Commit your changes with the message "New Project: Project Title"
• Push your changes to your fork's remote repository (the fork on your GitHub account)

Create a Pull Request

Now, create a Pull Request (PR) to the original xyntechx/NexLiber-Projects repository by following GitHub's official guide here.

Things to note:

• Title your PR "New Project: Project Title"
• Enter the project description, field, and difficulty in the comment field
• Additionally, enter your name, GitHub username, and Discord username in the comment field too

Your project must be reviewed and approved by an admin before it is merged into the main branch.

Next Steps

Upon merging, you will be assigned an Editor to monitor your progress in drafting the Workbook of your project. Please read the Workbook Dev Guide before writing and pushing your Workbook to xyntechx/NexLiber. Once you have completed your Workbook, it will be put up on NexLiber, and you will be a published NexLiber Creator!

Discord Community

If you have any questions regarding this process or NexLiber in general, raise it up on our Discord!