Skip to content
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.

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

Add Requires.io badge to README #1541

Merged
merged 2 commits into from
Jun 6, 2017
Merged

Add Requires.io badge to README #1541

merged 2 commits into from
Jun 6, 2017

Conversation

amplifi
Copy link
Contributor

@amplifi amplifi commented May 30, 2017

Proposed changes in this pull request

Adds Requires.io badge to README for package requirements status.

When should this PR be merged

Anytime

Risks

None; documentation only.

Follow-up actions

None

Checklist (for reviewing)

General

  • Is this PR explained thoroughly? All code changes must be accounted for in the PR description.
  • Is the PR labeled correctly? It should have the migration label if a new migration is added.
  • Is the risk level assessment sufficient? The risks section should contain all risks that might be introduced with the PR and which actions we need to take to mitigate these risks. Possible risks are database migrations, new libraries that need to be installed or changes to deployment scripts.

Functionality

  • Are all requirements met? Compare implemented functionality with the requirements specification.
  • Does the UI work as expected? There should be no Javascript errors in the console; all resources should load. There should be no unexpected errors. Deliberately try to break the feature to find out if there are corner cases that are not handled.

Code

  • Do you fully understand the introduced changes to the code? If not ask for clarification, it might uncover ways to solve a problem in a more elegant and efficient way.
  • Does the PR introduce any inefficient database requests? Use the debug server to check for duplicate requests.
  • Are all necessary strings marked for translation? All strings that are exposed to users via the UI must be marked for translation.

Tests

  • Are there sufficient test cases? Ensure that all components are tested individually; models, forms, and serializers should be tested in isolation even if a test for a view covers these components.
  • If this is a bug fix, are tests for the issue in place? There must be a test case for the bug to ensure the issue won’t regress. Make sure that the tests break without the new code to fix the issue.
  • If this is a new feature or a significant change to an existing feature? has the manual testing spreadsheet been updated with instructions for manual testing?

Security

  • Confirm this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets.
  • Are all UI and API inputs run through forms or serializers?
  • Are all external inputs validated and sanitized appropriately?
  • Does all branching logic have a default case?
  • Does this solution handle outliers and edge cases gracefully?
  • Are all external communications secured and restricted to SSL?

Documentation

  • Are changes to the UI documented in the platform docs? If this PR introduces new platform site functionality or changes existing ones, the changes must be documented in the Cadasta Platform Documentation.
  • Are changes to the API documented in the API docs? If this PR introduces new API functionality or changes existing ones, the changes must be documented in the API docs.
  • Are reusable components documented? If this PR introduces components that are relevant to other developers (for instance a mixin for a view or a generic form) they should be documented in the Wiki.

Copy link
Member

@oliverroick oliverroick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small thing... :shipit:

README.rst Outdated
@@ -66,6 +66,9 @@ Do this::

.. |build-status-image| image:: https://secure.travis-ci.org/Cadasta/cadasta-platform.svg?branch=master
:target: http://travis-ci.org/Cadasta/cadasta-platform?branch=master
.. |req-status-image| image:: https://requires.io/github/Cadasta/cadasta-platform/requirements.svg?branch=master
:target: https://requires.io/github/Cadasta/cadasta-platform/requirements.svg?branch=master
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link points to the image, shouldn't it point to https://requires.io/github/Cadasta/cadasta-platform/requirements/?branch=master

@amplifi
Copy link
Contributor Author

amplifi commented May 31, 2017

@oliverroick Haha, that would be more helpful wouldn't it. Fixed! Thanks :)

Copy link
Member

@oliverroick oliverroick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🏆

@amplifi amplifi force-pushed the readme-add-req-badge branch from d2c2330 to aee69b7 Compare June 6, 2017 10:02
@amplifi amplifi force-pushed the readme-add-req-badge branch from aee69b7 to 4133c96 Compare June 6, 2017 11:12
@amplifi amplifi merged commit f114c1a into master Jun 6, 2017
@amplifi amplifi deleted the readme-add-req-badge branch June 6, 2017 12:04
laura-barluzzi pushed a commit that referenced this pull request Jun 14, 2017
* add Requires.io badge

* Link the link
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants