create a CONTRIBUTING.md
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 76/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Domain
- documentation
Research direction
Review the referenced inspect-ai CONTRIBUTING.md as an example, then create CONTRIBUTING.md in the MathCAT repository. Include guidance about adding relevant unit tests and keeping issue and pull request messages human-written or clearly marked with an AI summary; the work is done when the repository has the new contributor guidance file.
Written by the indexing model from the issue text.
Description
While looking through the inspect-ai repo, I saw that they have a CONTRIBUTING.md file which might also make sense for us. From how I understand it, the name is automatically recognized and can be selected easily when looking at the repo, just like README.md
To me, things we might want to put in there are:
- add relevant unit tests whenever fitting (e.g. fixing a typo in a comment without it is fine)
- using AI is fine, but issues/PR messages should remain human-written, or have a dedicated block like "AI summary" at the end. The point is that nobody should be forced to read through walls of AI slop.
- Dominant language
- Rust
- Stars
- 119
- Forks
- 88
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 53
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from daisy/MathCAT
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Speak !! as double factorial in MathMLPossibly taken @AdamMagued claimed this 12 days ago. Openbug rules
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
discussion
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Maintainers usually reply within 1 day
-
discussion translation
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
daisy/MathCAT#675 · 1 comment ·
Maintainers usually reply within 1 day
-
feature request for vector from O to APossibly taken @moritz-gross claimed this 22 days ago. Openenhancement good first issue rules rust
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
daisy/MathCAT#621 · 1 comment · 1 assignee ·
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
NuSkooler/enigma-bbs#907 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
EasyTier/EasyTier#2672 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
bug good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
repowise-dev/repowise#3374 ·
Maintainers usually reply within 1 day