Skip to content

Improve Contributing Guide #290

Closed
@jaredcnance

Description

@jaredcnance

References

Examples of Things We Might Inclue

  • How to update documentation
  • Searching through issues
  • Proposing new features...The worst thing in the world is opening a PR that gets rejected.
  • Cloning the repo
  • Forking the repo
  • Setting up PostgreSQL (currently in README)
  • Running tests (currently in README)
  • Changing example app data models (e.g. don't use migrations)
  • Running the example apps
  • The build/release system
  • PR approval requirement
  • API Deprecration Strategy:
    1. Introduce new APIs in minor release, deprecate old APIs with error: false
    2. Deprecate old APIs in major release with error: true
    3. Remove old APIs in major release
  • New APIs must contain XML documentation (can fail the build for this?)
  • Debugging test failures via appveyor

image

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions