Skip to content

Latest commit

 

History

History
57 lines (48 loc) · 2.96 KB

CONTRIBUTING.md

File metadata and controls

57 lines (48 loc) · 2.96 KB

🎉 Thank you for your interest in contributing to this project✨

  • This is an ongoing project. No matter your skill level, you can contribute meaningfully.
  • Read the README if you don't know what this project is about.
  • Feel free to work on issues that match your skill level and you may leave comments, star the repo or add suggestions or issues.

☄️ Contribution Guidelines ⌚

  1. Setup
  2. Making changes
  3. Suggestions, Reporting Bugs or Creating Issues
  4. What can I do to contribute?
  5. Have a Question?

💻 Setup

  • Please clone the repo. This will be your working repository. For info on how to do that, click here.
  • The environment used to create the code was Bloodshed Dev-C++, however you may use VS Code or any other IDE.
  • Navigate to |Making changes| for more info on actually contributing code.

💫 Pretty simple, right? - If you have any issues with setup, feel free to message the [repo owner](/~https://github.com/Rehannah) for more info.

⭐ Making commits, PRs or submitting changes

  • Save commits to a new branch. Standard best practice suggests you name it with your username. For how to create a branch click here.
  • Go to Memory vs Gender Analysis Game.cpp and make any code adjustments there.
  • Go to words.txt and make add more words there. Note: Words must be 4-7 letters long (so that the difficulty is fair).
  • Go to README.md and make changes to the documentation there.
  • Go to CONTRIBUTING.md and make changes to the these guidelines there.

🐞 Suggestions/Bug/Issues reporting


How to contribute?

Current Issues:

New features or implementations:

  • store male and female data in a struct - or something more efficient.
  • use a dynamic data structure to store word list.
  • allow for a bigger word bank, so that the word list can be randomised.
  • include a larger data set of player data.
  • update README.md

Issues & Bugs:

  • Menu option 5 does not work.
  • Menu option 8 does not work.
  • Menu option 9 does not work.
  • fix typos in README.md.
  • fix typos in CONTRIBUTING.md.

💬Have a Question?