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

Contributing guide needed #39

Closed
pilosus opened this issue Jan 23, 2022 · 1 comment · Fixed by #49
Closed

Contributing guide needed #39

pilosus opened this issue Jan 23, 2022 · 1 comment · Fixed by #49
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@pilosus
Copy link
Owner

pilosus commented Jan 23, 2022

Not that we've got a volunteer contributor (#36), contributing guide is needed. Things to cover:

  • Add CONTRIBUTING.md with the guide (issue-first, ticket claims/assignments, clojure setup, tests & coverage, specs, changelog and authorship)
  • Add AUTHORS.md file
  • Add pull request checklist (tests & coverage are ok, CHANGELOG.md updated, AUTHORS.md updated, etc)
  • Check Django contributing page for inspiration
@pilosus pilosus self-assigned this Jan 23, 2022
@pilosus pilosus added the documentation Improvements or additions to documentation label Jan 23, 2022
@pilosus
Copy link
Owner Author

pilosus commented Jan 23, 2022

Another way to track authors/contributors is to ask to add github profile to the changelog, like pydantic does

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant