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

(S) As a AAA developer I want to have Contribution Guidelines and Developer documentation so that it is easy to contribute to my project #65

Closed
ryanlerch opened this issue Jan 9, 2020 · 7 comments
Assignees
Labels
S Small (~5 hours of work)
Projects

Comments

@ryanlerch
Copy link
Contributor

ryanlerch commented Jan 9, 2020

Note dependency: freeipa-fas: 13, #63 need to happen first.

** Note ** This was originally filed as fedora-infra/freeipa-fas: 17

Acceptance Criteria

  • Project contains documentation that describe how to setup the development environment
  • Project contains documentation that describe how to run the CI
  • Project contains documentation that describe how to contribute

DOD

  • All above completed
  • Reviewed
@abompard
Copy link
Member

abompard commented Jan 13, 2020

Blocked by PR #62 (US #63) because it needs the setup that is done there

@abompard abompard moved this from Blocked to Ready for review in AAA Jan 13, 2020
@abompard
Copy link
Member

For this user story I think PR #70 would be useful: it will make our documentation always accessible and buildable.

@sfinn85
Copy link

sfinn85 commented Jan 14, 2020

Great to see this in ready for review. Does the team member reviewing this, know what they need to review? :) Like the note about 70, how do we carry out this?

@abompard
Copy link
Member

PR #70 is merged now, and the PR #62 (merged too) has added a lot of developer documentation.
I guess that what's left in this ticket is to review the developer documentation we currently have and decide whether we find it clear and complete or not. It is visible on readthedocs.

@sfinn85
Copy link

sfinn85 commented Jan 15, 2020

Thanks @abompard.

@ryanlerch @relrod @StephenCoady this is ready for your review if you have capacity.

Thanks all

Sarah

@sfinn85
Copy link

sfinn85 commented Jan 21, 2020

@StephenCoady can you review this today so we can move it into done if you are happy with it before the sprint ends later today?

@StephenCoady
Copy link
Contributor

Sorry @sfinn85 this slipped through because the individual PRs were reviewed separately. Happy with the docs overall. Moving to done.

@StephenCoady StephenCoady moved this from Ready for review to Done in AAA Jan 21, 2020
@sfinn85 sfinn85 closed this as completed Jan 28, 2020
@sfinn85 sfinn85 moved this from Done within Sprint to Overall Done in AAA Feb 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S Small (~5 hours of work)
Projects
No open projects
AAA
  
Overall Done
Development

No branches or pull requests

4 participants