Skip to content

Improve Contributing Guide #290

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
jaredcnance opened this issue Jun 5, 2018 · 0 comments · Fixed by #962
Closed

Improve Contributing Guide #290

jaredcnance opened this issue Jun 5, 2018 · 0 comments · Fixed by #962
Labels
documentation help wanted

Comments

@jaredcnance
Copy link
Contributor

jaredcnance commented Jun 5, 2018 •
edited
Loading

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation help wanted
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Coding guidelines cibuild json-api-dotnet/JsonApiDotNetCore
1 participant
@jaredcnance