Skip to content

Latest commit

 

History

History
44 lines (33 loc) · 2.45 KB

CONTRIBUTING.md

File metadata and controls

44 lines (33 loc) · 2.45 KB
Raw

Contributing

Contributions are appreciated! The following guide is a rough draft, but please feel free to contribute to this contribution doc as well :D

Issues

When submitting an Issue, please provide the following:

  • If it's a feature request, then write why you want it, but also which other cases you find it useful for. Best way to get a new feature made by others is to motivate.
    • Think about challenges.
    • Have you read the Manifesto (below) ? New features should maintain the focus of the project.
  • If you encounter a bug, keep in mind that it's probably easiest to fix if a developer sat in front of your computer... but in lack of that option:
    • django-admin.py --version
    • python --version
    • uname -a
    • An example of how to reproduce the bug.
    • The expected result.
    • Does the bug happen with a checkout of django-wiki's master branch? To upgrade: pip install --upgrade git+https://github.com/benjaoming/django-wiki.git

Pull requests

When submitting a pull request, please do the following.

  • If it contains Python code, please consider adding a test case.
  • If it's a look and feel change, please add a screenshot.
  • If you add support to other versions of dependencies, please add a Travis .yml configuration.

Manifesto

Django needs a mature wiki system appealing to all kinds of needs, both big and small:

  • Be pluggable and light-weight. Don't integrate optional features in the core.
  • Be open. Make an extension API that allows the ecology of the wiki to grow. After all, Wikipedia consists of some 680 extensions written for MediaWiki.
  • Be smart. This is the map of tables in MediaWiki - we'll understand the choices of other wiki projects and make our own. After-all, this is a Django project.
  • Be simple. The source code should almost explain itself.
  • Be structured. Markdown is a simple syntax for readability. Features should be implemented either through easy coding patterns in the content field, but rather stored in a structured way (in the database) and managed through a friendly interface. This gives control back to the website developer, and makes knowledge more usable. Just ask: Why has Wikipedia never changed? Answer: Because it's knowledge is stored in a complicated way, thus it becomes very static.