Adding Contributor Guidelines
Description
Currently, this project doesn't include any information on how to contribute or if contributions are welcome. I suggest that there is information for contributors.
Proposed Solution
Add a section to the READEME with contribution guidelines (including information like commit formulas, AI policies, and types of previous contributions or issues). Alternatively, create a "Code of Conduct" or "Contribution Guidelines" page that layout contributor expectations.
Why This Matters
Developers need guidance when it comes to contribution to open source projects. If expectations are clear, maintainers will have to do less work when it comes to approving PRs by contributors (ex: if there are guidelines on AI usage, it could prevent "AI slop"). Also, a barrier to entry in contributing to pen source projects is often unclear or missing expectations and documentation. If Braille2Latex wants help from outside contributors, having clear expectations would be beneficial. Additionally, it's important for developers to understand when it's appropriate to contribute to an open source project vs just use/be inspired by an open source project.
Open Questions
- Can/should people with no experience with Braille work on this project? (for example, I don't know how to read Braille)?
- Was AI used in this project? Should AI be used further by new contributors?
- What would a commit formula look like (how should people be writing their commit messages)?
Adding Contributor Guidelines
Description
Currently, this project doesn't include any information on how to contribute or if contributions are welcome. I suggest that there is information for contributors.
Proposed Solution
Add a section to the READEME with contribution guidelines (including information like commit formulas, AI policies, and types of previous contributions or issues). Alternatively, create a "Code of Conduct" or "Contribution Guidelines" page that layout contributor expectations.
Why This Matters
Developers need guidance when it comes to contribution to open source projects. If expectations are clear, maintainers will have to do less work when it comes to approving PRs by contributors (ex: if there are guidelines on AI usage, it could prevent "AI slop"). Also, a barrier to entry in contributing to pen source projects is often unclear or missing expectations and documentation. If Braille2Latex wants help from outside contributors, having clear expectations would be beneficial. Additionally, it's important for developers to understand when it's appropriate to contribute to an open source project vs just use/be inspired by an open source project.
Open Questions