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

Set up project metadata #7

Closed
Technologicat opened this issue Oct 17, 2020 · 3 comments
Closed

Set up project metadata #7

Technologicat opened this issue Oct 17, 2020 · 3 comments
Labels
enhancement New feature or request
Milestone

Comments

@Technologicat
Copy link
Owner

Technologicat commented Oct 17, 2020

  • AUTHORS.md Done in c1086e5.
    • Include also indirect contributions (e.g. Alex Leone's astpp, and the design of the quasiquote system from macropy).
    • Note which license each contribution is used under.
  • CHANGELOG.md Added in 284a7bf. Now just to keep it up to date...
    • Describe changes between mcpy 2.0.0 and mcpyrate 3.0.0.
  • CONTRIBUTING.md? Done in 6d1a624.
    • Could move the Understanding the code section here.
    • Follow PEP8, but not into foolish consistency.
    • A blank line (or a double-blank line when appropriate) is a paragraph break, to separate logical units. Just like when writing prose, don't break the paragraph inside a logical unit, no matter what flake8 tells you. This helps make the overall structure explicit and easy to see at a glance.
  • Configure badges in README.md (see unpythonic).
  • We use semver, note it somewhere? Done in 48d7fa3.
    • 6d1a624 notes it in CONTRIBUTING.md, but should add a note to README.md, too, for users.
@Technologicat Technologicat added this to the 3.0.0 milestone Oct 17, 2020
@Technologicat Technologicat added the enhancement New feature or request label Oct 17, 2020
@Technologicat Technologicat modified the milestones: 3.0.0, 3.1.0 Nov 12, 2020
@Technologicat
Copy link
Owner Author

As of 50e0e68, we're only missing CI status and codecov, which depend on #2 and #5.

@Technologicat
Copy link
Owner Author

As of f8d8072, we're only missing codecov.

@Technologicat
Copy link
Owner Author

As of f4cbb24, we have codecov, too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant