Skip to content

Latest commit

 

History

History
167 lines (146 loc) · 6.77 KB

CONTRIBUTING.md

File metadata and controls

167 lines (146 loc) · 6.77 KB
Raw

Contributing

All projects under the Pylons Projects, including this one, follow the guidelines established at How to Contribute, Coding Style and Standards, and Pylons Project Documentation Style Guide.

You can contribute to this project in several ways.

Git branches

Git branches and their purpose and status at the time of this writing are listed below.

  • master - The branch which should always be deployable. The default branch on GitHub.
  • For development, create a new branch. If changes on your new branch are accepted, they will be merged into the master branch and deployed.

Prerequisites

Follow the instructions in README.md to install the tools needed to run the project.

Adding an add-on to "Extending Pyramid" page

We list official and community contributed add-ons under Extending Pyramid. To add an add-on:

  1. Create a new branch off of master.
  2. Duplicate an existing file in data/addons/, and rename it to your add-on's name. For example, data/addons/deform.yaml.
  3. Edit it as needed, following YAML syntax.
  4. Optionally build the site locally to ensure it renders correctly.
  5. Submit a pull request with your changes.

Example file and notes

addon: false
category:
- forms
demoUrl: https://deformdemo.pylonsproject.org/
description: A Python HTML form generation library.
docsUrl: https://docs.pylonsproject.org/projects/deform/en/latest/
maintainers:
- chrism
- miohtama
- ericoandrei
- stevepiercy
name: deform
projectUrl: ''
pypiUrl: https://pypi.org/project/deform
support: pylons
vcsUrl: https://github.com/Pylons/deform
  • addon: true or false. An add-on is a package which relies on Pyramid itself and extends the functionality of Pyramid.
  • category: Select at least one but don't go crazy, or suggest a new category. Categories include:
    • api
    • asset-management
    • async
    • authentication
    • authorization
    • caching-and-sessions
    • configuration
    • debugging
    • development-environment
    • documentation
    • email
    • forms
    • internationalization-i18n
    • media-management
    • monitors
    • renderers
    • requests
    • routes
    • routing
    • scaffolds
    • search
    • services
    • sessions
    • storage
    • task-queueing
    • template-languages
    • testing
    • url-shorteners-and-managers
    • user-interface-and-user-experience-ui-and-ux
    • web-page-utilities
    • wsgi-servers
  • demoUrl: The URL of your package's demonstration. If none, then use the empty string, ''.
  • description: A description of your package.
  • docsUrl: The URL of your package's documentation. If none, then use the empty string, ''.
  • maintainers: A list of maintainers of your package on PyPI.
  • name: The name of your project.
  • projectUrl: The URL of your package's home page. If none, then use the empty string, ''.
  • pypiUrl: The URL of your package on PyPI. If none, then use the empty string, ''.
  • support: Select one of the following options.
    • pylons: Official Pylons Project
    • community: Community
    • unsupported: Unsupported
  • vcsUrl: The URL of your package's version control system, such as GitHub or Gitlab. If none, then use the empty string, ''.

Adding your company, organization, application, or website to "Powered by Pyramid" page

We list companies, organizations, applications, or websites under the Powered by Pyramid page. To add your entity to the listing:

  1. Create a new branch off of master.

  2. From the directory poweredBy, duplicate an existing file in the appropriate subdirectory, and rename it to your entity's name. The directory names correspond to the entity's category.

    1. orgs: organizations and companies
    2. apps: applications
    3. websites: websites
    4. kotti: websites based on Kotti
    5. websauna: websites based on Websauna

  3. Edit it as needed, following YAML syntax.

  4. If you include a logo, place it on a transparent background and is size it to 700 pixels wide by 200 pixels tall. Add your logo's URI to src/main.js in the appropriate section, alphabetically.

  5. Optionally build the site locally to ensure it renders correctly.

  6. Submit a pull request with your changes.

Example file and notes

category: floss
demoUrl: https://pypi.org/
description: <p>Warehouse is a next generation Python Package Repository designed
  to replace the legacy code base that currently powers PyPI.</p>
docsUrl: https://warehouse.readthedocs.io/
logo: warehouse-pypi-logo.png
maintainers: []
name: warehouse
projectUrl: https://pypi.org
pypiUrl: ''
vcsUrl: https://github.com/pypa/warehouse
  • category: Select one of the following options.
    • comorg: company or organization
    • floss: free and libre open source project or application
    • website: Pyramid-only-based website
    • kotti: Kotti-based website
    • websauna: Websauna-based website
  • demoUrl: The URL of your entity's demonstration. If none, then use the empty string, ''.
  • description: A description of your entity.
  • docsUrl: The URL of your entity's documentation. If none, then use the empty string, ''.
  • logo: Your entity's logo. The logo will be resized to 700 pixels wide by 200 pixels high. SVG format is preferred.
  • maintainers: A list of maintainers. If none, then use the empty YAML list of [].
  • name: The name of your entity.
  • projectUrl: The URL of your entity's home page. If none, then use the empty string, ''.
  • pypiUrl: The URL of your entity on PyPI. If none, then use the empty string ''.
  • vcsUrl: The URL of your entity's version control system, such as GitHub or Gitlab. If none, then use the empty string, ''.