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 contribution guideline and pull request template for adding packages #167

Closed
torik42 opened this issue Jan 25, 2021 · 1 comment · Fixed by #179
Closed

Add contribution guideline and pull request template for adding packages #167

torik42 opened this issue Jan 25, 2021 · 1 comment · Fixed by #179
Labels
type: documentation Improvements or additions to documentation

Comments

@torik42
Copy link
Owner

torik42 commented Jan 25, 2021

I myself had to look into old pull requests to see what needs to be done. I had the yalafi/packages/package_name.py before. But also other things need to be done. And still, I missed some.

It would be super nice, to have a short list on what needs to be done and also a checkmark list in some pull request template. For example

Add support for LaTeX package .

Checklist

  • Add a file yalafi/packages/package_name.py implementing all the needed commands of the package.
  • Add a file yalafi/tests/test_packages/test_package_name.py testing all the features.
  • Add the package and implemented features to list-of-macros.md and reference it in the Contents section.
  • Add the package to the default package list in yalafi/packages/__init__.py.

Hopefully, I did not forget a step. The same, of course, would be nice for document classes.

@matze-dd matze-dd added the type: documentation Improvements or additions to documentation label Jan 26, 2021
@matze-dd
Copy link
Collaborator

Thank you for this useful feedback and equally useful proposal! I'll definitely come back to this issue.

matze-dd added a commit that referenced this issue Jan 31, 2021
matze-dd added a commit that referenced this issue Jan 31, 2021
@matze-dd matze-dd mentioned this issue Jan 31, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants