home

Welcome to the StuPlace wiki!

How to Contribute to the Project

1. Make an issue

a. Issue Description:

**Is your feature request related to a problem? Please describe.**
[describe what is the problem]
**Describe the solution you'd like**
[suggest a solution]

b. Set sidebar

• Assignees: set to yourself if you are going to work on, or leave it empty.
• Labels: set to any relatable label to the issue.
• Projects: set to current project work if the feature is related to it.

2. Working on the Issue

a. Before you start working

• On the issue page, set Project to In progress to let others know that you are working on it.
• In your local machine, after you pulled the main branch, run the following:

git checkout -b [branch-name]

b. After you are done working

After you complete the task, run the following commands:

git add .
git commit -m "[describe the changes in short]"
git push origin [branch-name]

3. Make a Pull Request

On the browser, make a pull request with the following settings:

• Reviewers: select someone to review if you know, or leave it empty.
• Projects: set to current project work if the feature is related to it.
• Linked issues: link the main issue that you created for this pull request.

4. Let Others Review Your Work

Notify Mutlaq Aldhbuiub about the pull request and ask for someone or even Mutlaq to review it.

5. Done!

After someone reviews and accepts it, make sure you don't have anything to add to this pull request. If not, merge the pull request to main branch and delete the pull request's branch. Congrats! 👍 🔥 💯 🥇

Thanks to SudoGroup

Thanks to Sudo Group especially sudomaze(Mazen) because he let me use the wiki page of SudoBot