Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

76 lines (50 loc) · 1.83 KB

🌍 Contributing.

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

👶 Getting Started!

Ready to contribute? Here's how to set up moerphous-server for local development.

  1. Fork the moerphous-server repo on GitHub.
  2. Clone your fork locally:
git clone git@github.com:your_name_here/moerphous-server.git
  1. Create a virtualenv with make:
make venv
  1. Activate the virtualenv:
source .venv/bin/activate
  1. Install the main dependencies into the virtualenv using poetry and make. Assuming you have poetry installed, this is how you set up your fork for local development:
make install

Note: This command will automatically generate a .env file from .env.example, uninstall the old version of poetry on your machine, then install latest version 1.2.2, and install the required main dependencies.

  1. Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

  1. When you're done making changes, check that your changes pass tox tests, including testing other Python versions with make:
make test-all
  1. Commit your changes and push your branch to GitHub:
git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature
  1. Submit a pull request through the GitHub website.

📙 Pull Request Guidelines.

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests, if possible.
  2. The pull request should work for Python 3.9.10. Check and make sure that the tests pass for all supported Python versions.

💡 Tips.

To run a subset of tests:

make test
make lint
make coverage

Thank you for helping us improve!