Note
If you are reading this, you are probably interested in contributing to Majo.exe. We appreciate your interest in improving the project and welcome your contributions. To ensure a smooth and productive collaboration, please review the following guidelines.
We know that contributing to a project can be intimidating, especially if you are new to the community. However, we want to assure you that contributing to Majo.exe is easy and fun.
We have created a welcoming community that encourages collaboration and supports new contributors. We are excited to have you on board! 🙌
Start by reviewing the existing issues to identify areas where your contributions can make a significant impact.
If you have new features, enhancements, or bug fixes in mind, you can create a new issue to propose your contributions. Please provide comprehensive details to clearly explain your ideas. This will help the project maintainers and fellow contributors to understand your suggestions and provide valuable feedback.
To initiate your contribution, fork the primary repository by clicking the "Fork" button. This creates a copy of the repository in your personal GitHub account. You will use this copy to make and propose changes to the project.
After forking the repository, clone your forked repository to your local development environment using the following command:
git clone https://github.com/your-username/majo.exe.git
cd majo.exeThis creates a local copy of your forked repository on your computer in directory majo.exe.
Note
Replace your-username with your GitHub username
To keep your forked repository in sync with the primary repository, set up the upstream remote using the following command:
git remote add upstream https://github.com/IgorKowalczyk/majo.exe
git remote -vBefore you can start working on your contribution, create a new branch dedicated to your specific task:
git checkout -b my-contributionNote
Replace my-contribution with a descriptive name that clearly identifies the purpose of your branch. Please use lowercase letters and hyphens instead of spaces.
Now you can start working on your contribution! Implement your awesome ideas, fix bugs, or add new features. Be creative and have fun! Ensure your contributions are well-structured, documented, and aligned with the project's objectives.
Quick Tip: To keep your forked repository in sync with the primary repository, pull the latest changes from the primary repository before making your contributions:
git pull upstream mainImportant
Remember to test your changes before submitting them! You can read the README.md file for instructions on how to set up the project locally.
Note
- Please ensure your code is well-formatted and linted before submitting your changes.
- To format your code, use the following command:
pnpm run format - To lint your code, use the following command:
pnpm run lint:fix - To build the project, use the following command:
pnpm run build
Commit your awesome contributions with informative commit messages that clearly explain the purpose of your changes:
git commit -m "Add a descriptive message here"Warning
Please ensure your commit messages are descriptive and informative. This will help the project maintainers and fellow contributors to better understand your changes.
Please do not use vague commit messages like Update README.md or Fix bugs. Instead, use messages like Update README.md with instructions on how to set up the project locally or Fix bugs related to incorrect variable names.
Push your commits to your forked repository on GitHub:
git push origin my-contributionNote
Replace my-contribution with the name of your branch.
Visit your forked repository on GitHub and click the "Compare & pull request" button to create a pull request from your branch to the primary repository.
Please provide comprehensive details to clearly explain your changes. This will help the project maintainers and fellow contributors to understand your contributions and provide valuable feedback.
Note
Please ensure your pull request is well-formatted and linted before submitting it. This will help the project maintainers and fellow contributors to work with your code more efficiently, and it will increase the likelihood of your pull request being accepted.
Wait for the project maintainers to review your pull request. Be prepared to address any suggested changes or refinements. Reviewers may ask you to make changes to your pull request before it can be accepted. Please be patient and respond to any questions or requests in a timely manner.
We know that waiting for your pull request to be accepted can be stressful. Please be assured that we will do our best to review your pull request as soon as possible. We appreciate your patience and understanding ❤️🔥
Want to contribute to Majo.exe but don't know where to start? Join our community! We have created a welcoming community that encourages collaboration and supports new contributors. We are excited to have you on board! 🙌
We created a Discord server for the Majo.exe community. Join the server to connect with fellow contributors and get support from the project maintainers. We look forward to collaborating with you! 🚀👾🙌
We want to hear from you! Your feedback is vital for the project's development and success. If you have any questions, suggestions, or concerns, please feel free to contact the project maintainers. We are always happy to help! 🙌
You can contact the project maintainers by joining the Discord server or opening an issue on GitHub.
Help us spread the word about Majo.exe! We would love to see more people join our community and contribute to the project. Please share the project with your friends and colleagues. We appreciate your support! 🙌
Thank you for your valuable contributions, and we look forward to collaborating with you on the Majo.exe project! 🚀👾🙌