Skip to content

Latest commit

 

History

History
105 lines (73 loc) · 4.44 KB

CONTRIBUTION.md

File metadata and controls

105 lines (73 loc) · 4.44 KB
Raw

📜 Contributing Guidelines

This document will guide you through the process of contributing to our repository. We value the time and effort of our contributors, and we strive to create an inclusive and collaborative community. We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. Thank you for helping out and remember, no contribution is too small.

Please note we have a code of conduct please follow it in all your interactions with the project.


🔁 Ways to Contribute (!Important)

So by now you understood what this project is about but what exactly we would be doing in these 3 months? The goal of this repo is to create multiple games (we are not focused on one game but we would be making many small-big adventure games with their own stories) To acheive this task we need to follow these steps.

  1. Fork the repo
  2. Create a new folder (IMP) and start creating your gaming files
  3. Issues would be sub divided meaning, a game can be divided into sub parts, one issue for making prompts, one for creating gaming assets like characters and last one for creating actual game python file
  4. After doing your task make a pull request
  5. Make sure you do not change someone else file.
  6. Plagiarism is big no and doing so may result in lost of ranks and ban from repo.
  7. Based on efforts levels will be given
  8. If any issue contact me on tusharamd#5800 on discord

📈 Development Workflow

When working on the project, please follow these guidelines:

  1. Always work on a new branch for each separate issue or feature.
  2. Keep your branch up to date with the main repository's master branch.
  3. Write clear and descriptive commit messages.
  4. Test your changes thoroughly before submitting a pull request.
  5. Keep discussions polite and respectful.

🚩 Issue Report Process

  1. Go to the project's issues.
  2. Select the template that better fits your issue.
  3. Give proper description for the issues.
  4. Don't spam to get the assignment of the issue.
  5. Wait for till someone is looking into it !.
  6. Start working on issue only after you got assigned that issue.

Need Help regarding some basics? 🤔

You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:


Pull Request Process 🚀

  1. Ensure that you have self reviewed your code.
  2. Make sure you have added the proper description for the functionality of the code.
  3. I have commented my code, particularly in hard-to-understand areas.
  4. Add screenshot it help in review.
  5. Submit your PR by giving the necesarry information in PR template and hang tight we will review it really soon.

🤝 Community Guidelines

We expect all contributors to adhere to the following community guidelines:

  1. Be respectful and considerate towards others.
  2. Use inclusive language and promote a welcoming environment.
  3. Avoid personal attacks, harassment, or discrimination.
  4. Keep discussions on-topic and constructive.
  5. Help others and contribute positively to the community.

Documentation 📑

  • Document any significant changes or additions to the codebase.
  • Provide clear and concise explanations of the functionality, usage, and any relevant considerations.

✅ Code Reviews

  • Be open to feedback and constructive criticism from other contributors.
  • Participate in code reviews by reviewing and providing feedback.

🚀🚀Feature Requests

  • Suggest new features or improvements that you believe would enhance the project.

☘️ Spread the Word

  • Share your experience and the project with others.
  • Spread the word about the project on social media, developer forums, or any relevant community platforms.
  • Thank you for your valuable contribution and for being a part of the Clueless Community! Together, we can make a difference. 🚀

Happy Contributing 🔥