-
Notifications
You must be signed in to change notification settings - Fork 122
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
docs(Configuration): Move docs to the main branch and add info about custom fragment types. #368
Conversation
Codecov Report
@@ Coverage Diff @@
## master #368 +/- ##
=======================================
Coverage 96.85% 96.85%
=======================================
Files 20 20
Lines 1241 1241
Branches 120 120
=======================================
Hits 1202 1202
Misses 20 20
Partials 19 19 Continue to review full report at Codecov.
|
Thanks for the update. There is on issue...towncrier uses towncrier and we have a CI check :)
But I don't see that this is documented. It looks like you need to create a file inside "src/towncrier/newsfragments/367.doc" with a sentence describing that the documentation was moved into the main branch. See #343 I think the current CONTRIBUTING.rst should be moved into the docs and renamed "docs/release-process.rst" And we can have a separate docs/CONTRIBUTING.rst file in which we add a few info for contributors... like requiting to have all tests green, to support all the python verison and to add a release note fragment. But this can be done in a separate PR. If you have time, it would be nice to look together into #343 and unblock it. And instead of creating repo files, integrate those pages into the docs. So we should merge this PR first. For this PR is enough to add the src/towncrier/newsfragments/367.doc Thanks |
and I now see #89 So it looks like the docs are in the current branch as the PR was not merged. @danieljmv01 you can review the feedback from that PR. But at this time, I think is best to just merge what we have and then we can fix thinks in other PRs. |
bf7d139
to
e2022e9
Compare
let me know when you think this PR is ready for review and merge. Thanks |
* Describe how to add custom fragment types. Resolves: twisted/twisted#367 Signed-off-by: danieljmv01 <[email protected]>
e2022e9
to
46cbad2
Compare
Hi @adiroiban, I have included the newsfragment and rebased, so I think that it is ready for review. Thanks! |
Resolves: twisted/#367