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

docs(Configuration): Move docs to the main branch and add info about custom fragment types. #368

Merged
merged 6 commits into from
Feb 15, 2022

Conversation

danieljmv01
Copy link
Contributor

  • Describe how to add custom fragment types.

Resolves: twisted/#367

@codecov
Copy link

codecov bot commented Feb 13, 2022

Codecov Report

Merging #368 (46cbad2) into master (a0a34d3) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a0a34d3...46cbad2. Read the comment docs.

@adiroiban
Copy link
Member

adiroiban commented Feb 13, 2022

Thanks for the update.

There is on issue...towncrier uses towncrier and we have a CI check :)

CI / Check Newsfragment - Failed
No new newsfragments found on this branch.

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

@adiroiban
Copy link
Member

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.

@adiroiban
Copy link
Member

let me know when you think this PR is ready for review and merge. Thanks

@danieljmv01
Copy link
Contributor Author

Hi @adiroiban, I have included the newsfragment and rebased, so I think that it is ready for review. Thanks!

@adiroiban adiroiban changed the title docs(Configuration): Add Custom fragment types docs(Configuration): Move docs to the main branch and add info about custom fragment types. Feb 15, 2022
@adiroiban adiroiban enabled auto-merge February 15, 2022 08:52
@adiroiban adiroiban merged commit 27cd970 into twisted:master Feb 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants