Skip to content

Latest commit

 

History

History
50 lines (35 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

50 lines (35 loc) · 1.84 KB

CONTRIBUTING

Thank you for considering contributing to my project! It's very kind. However, be sure to read the code of conduit and the style guide before to contribute.

How to file a bug report?

Go in issues, then click on new issue and select bug report

How to suggest a new feature?

Go in Discussions. Any suggestion is welcome! Of course, everything isn't possible, but giving your opinion or thought about improving this project is good.

How to propose your modifications?

  1. Fork my project
  2. Commit to your repository
  3. Open a pull request on the Develop branch on my repository
  4. Grab a drink and wait for my review (You can expect me to acknowledge it in a few days)
  5. Discuss / edit your pull request with me if needed
  6. Get merged! :D
  7. Get credited. UwU

How to set up your environment and run tests?

Using conda

You can use conda to create the environment.

  1. Install miniconda
  2. Run conda env create --file conda_config.yml command
  3. Activate aidventure environment conda activate aidventure
  4. Run the server.py script or any of the server's scripts.

Using pip

  1. Install the packages listed in requirements.txt
  2. Run the server.py script or any of the server's script.

The types of contributions I'm looking for

As long as you feel useful to contribute, do so! You can contribute by making some doc, scripts, Github actions, giving some design advice or even suggestions.

How can you get in touch with me?

You can start a discussion in the discussions tab or you can join my Discord server. If you are more old school you can send me an email at [email protected] :).

Useful resources