This Document will make sure you know what you can and cannot do. It will also help you find your way around git and how you can add onto this project.
First, we will have to go over some rules. When making a pull request for your feature, these rules will be checked by our reviewers.
Note to our Verfied Contributors: These are not the full rule set you have to follow. For the Full Rules Please See Discord or the Contributor Rules found here
When you make changes to the wiki, you must make sure you comment on your work/code, and when making a commit, you must say what you have changed in the commit clearly. Speak like you're giving an action.
- "fix: typo in about section"
- "add: mobile responsiveness to navigation"
- "edit: contact information"
When working on a feature, make sure to make a new branch for this so you do not commit directly into the main branch. You must do your work in your branch, and when it is ready for production, you may make a pull request to merge it into the main branch. Only the creator of the branch should make pull requests for the branch.
When you submit a pull request, you should make sure you include the following:
- A clear title summarizing the changes
- Description of what was changed and why
- Any relevant issue numbers (if applicable)
Keep it to one change per commit. Make sure not to make a bunch of unrelated changes in one commit. If your commit is about organizing files, organize them, then when you do the next step, make sure that in another commit. In other words, make sure commits are related.
Now we have gotten that out the way we can move onto how you add to the wiki.
Before contributing, make sure you have:
- Git SCM installed on your machine
- A GitHub account
- Basic familiarity with CLI, HTML, CSS, and JavaScript
-
Fork the repository by clicking the "Fork" button on the GitHub repository page
-
Clone your fork to your local machine:
git clone https://github.com/yourusername/repository-name.git cd repository-name -
Create a new branch for your changes:
git checkout -b feature/your-feature-name
Before submitting your pull request:
- Verify all links work correctly
- Test on both desktop and mobile viewports
- Validate HTML markup
- Check for spelling and grammar errors
- Ensure no layout breaks or visual regressions
-
Stage and commit your changes:
git add . git commit -m "Your descriptive commit message"
-
Push to your fork:
git push origin feature/your-feature-name
-
Create a Pull Request:
- Navigate to your fork on GitHub
- Click "Compare & Pull Request"
- Fill out the PR template with:
- Title: Clear, specific description of what you changed
- Description: Explain what you changed, why you changed it, and any potential impacts
- You must not review your own PR
- All pull requests require review before merging
- Address any feedback provided by maintainers
- Keep discussions constructive
- Be patient as reviews may take some time
If you need assistance:
- Check existing issues for similar questions
- Create a new issue with the "question" label
- Join our Discord server (if applicable)
- Review the project documentation
We're a diverse group of contributors from different backgrounds and communities. Whether you're a student, professional developer, artist, gamer, or just someone who wants to help improve the project - you're welcome here.
What matters most is your willingness to contribute positively to the project and treat fellow contributors with respect.
All contributors will be acknowledged in our project. Your contributions help make this project better for everyone!
Please note just from adding one feature to the wiki doesn't mean you will get the contributor role. Guidelines on how to get the role will be posted at a later data.
Thank you for contributing to our project! 🎉