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

Get all ash-project repositories cleaned up and ready to be worked on #17

Closed
30 tasks done
zachdaniel opened this issue May 31, 2020 · 0 comments
Closed
30 tasks done
Projects

Comments

@zachdaniel
Copy link
Contributor

zachdaniel commented May 31, 2020

We should refer back to this list when setting up any new repos:

  • Delete/archive any current issues/tickets
  • Remove any unnecessary GH repos
  • Descriptions on all repos (under the repo name)
  • Topics for all repos (under description)
  • Remove Ashton, replace it with https://github.com/dashbitco/nimble_options, delete ashton repo
  • Add git_ops to each repo, create initial release
  • Publish to hex
  • Make the hex documentation the repo home-page
  • Licenses, with a badge
  • Contributor guidelines
  • Code of Conduct
  • Pull request template with commit name requirements
  • Issue templates
  • code coverage
  • Readme with at minimum a short summary and an example of usage (tickets created to this effect)
  • Any long-form writing moved to in-code documentation.
  • All todos into GH issues/triaged/removed if out of date
  • CI - with all of the steps runnable by mix check https://github.com/karolsluszniak/ex_check, running on a matrix of different elixir/downstream dependency versions (e.g Ecto, Phoenix)
  • Badges for all CI checks/anything relevant
  • CI automatically deploys when a new release is pushed
  • Ensuring only the maintaining team can push to master
  • Requiring PR approvers
  • Requiring PRs pass a Continuous Integration build
  • guidelines on using issues
  • Uniform GitHub labels
  • All public interfaces at minimum specced, but ideally with function/module docstrings The primary one in ash was done, but I think we can push off more documentation for later.
  • All private modules with @doc false (we can be overeager with this for now, and do a more comprehensive documentation pass later) - done for ash
  • Logo?
  • Ensure reasonable test coverage for all repos this shouldn't be part of the initial cleanup.
  • Ensure ash.formatter --check is being run on CI
@zachdaniel zachdaniel added this to To do in Alpha via automation Jun 5, 2020
Alpha automation moved this from To do to Done Jun 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Alpha
  
Done
Development

No branches or pull requests

1 participant