Skip to content

Latest commit

 

History

History
81 lines (58 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

81 lines (58 loc) · 2.46 KB
Raw

Contributing to MangAdventure

Thank you for your interest in contributing!

Issues

Security vulnerabilities ought to be reported according to our security policy.

For any other issue, follow these steps:

  1. Check whether it's already on our issue tracker.
  2. Make sure you are using our latest release.
  3. Search the internet (Google/Stack Overflow/etc.).
  4. If still needed, submit it using the corresponding template.

Pull Requests

Before submitting a pull request, please read the guidelines below.

Development

You can clone and install the project with the following commands:

git clone https://github.com/mangadventure/MangAdventure
cd MangAdventure
python -m venv .venv
source .venv/bin/activate
pip install -e .[dev,docs,debug]

Before proceeding, there are some settings you will need to configure.
To configure them, copy the .env.example file to .env and edit it.

Now, you can set up the project and run a development server:

mangadventure migrate # create database
mangadventure collectstatic # collect static files
mangadventure createsuperuser # create administrator
export MANGADV_DEBUG=1 # enable debug mode
mangadventure runserver # start server

After starting the server, you can go to http://localhost:8000/admin-panel/ and log in with the administrator account you created earlier to add content to the site.

You can lint the code and run tests like so:

scripts/lint.sh # lint
py.test # run tests

After creating a new python file, run this to update the docs:

make -Cdocs modules

Code Style

Follow the style defined by EditorConfig.

Commit Messages

  • Limit the title to 50 characters.
  • Use imperative form in the title.
    • "Fix" rather than "Fixed" or "Fixes".
  • Start the title with a capital letter.
  • Do not include tags like feat: or [BUG].
    • [no ci] is used to skip workflows.
  • Use the body to elaborate if needed.
  • Wrap lines in the body to 72 characters.