Skip to content

Conversation

@LauraLangdon
Copy link
Contributor

Adding missing content for repo docs (contributing, readme) for #12. I'm far from finished, so keeping this a draft for now.

@LauraLangdon LauraLangdon self-assigned this Oct 29, 2025
@LauraLangdon LauraLangdon added the documentation Improvements or additions to documentation label Oct 29, 2025
@LauraLangdon LauraLangdon linked an issue Oct 29, 2025 that may be closed by this pull request
7 tasks
@github-project-automation github-project-automation bot moved this to Triage in DA Tech Oct 29, 2025
@LauraLangdon LauraLangdon moved this from Triage to In Progress in DA Tech Oct 29, 2025
@finnporter
Copy link

finnporter commented Nov 5, 2025

Hi @LauraLangdon , as discussed:

I'd like to add some things that are good coding practices and that people can use to work and also to look at before submitting a PR to make PRs slimmer and faster to review. Some of these could be worked into a checklist for PRs, some are just best practices that help avoid issues later and some could go into a README and we'll hope people read it ;) These are the things that came to mind right now but more might pop up when doing more PR reviews.

  • when starting to work, merge main into your branch so that you're not behind and avoid merge conflicts later on

  • when you're done for the day, commit and push your changes, even if it's not done or breaks, but if someone else needs to take over, then no work is lost and maintainers can get an idea of the progress of an issue

  • coding principles: before a PR, check if you have classes, files, etc. that do more that they should, dependencies that are unnecessary, etc. (keyword SOLID and KISS)

  • run tests before creating a PR

  • naming conventions e.g website specific: using reusable file names that make sense in more than one context. e.g. homepageData.ts testimonials.ts

  • more naming conventions, when to use camelCase, PascalCase,etc. for things. there are common conventions, best practices, etc. that help keep it clean. This is probably repo specific. eg. for the website

Category Example name File name Why
React component Testimonials Testimonials.tsx Capitalized because JSX tags must start with an uppercase letter to be treated as components.
Data / config / constants / plain TS modules partnerTestimonials partnerTestimonials.ts Lowercase (camelCase or sometimes snake_case) because they’re values, not types or components.
Type or interface ImpactItem (.ts/.tsx) PascalCase to clearly mark a type-level construct rather than a runtime value.
Constant / enum-like value API_URL constants.ts UPPER_SNAKE_CASE for immutable, global configuration values.
Utility / helper function formatNumber formatNumber.ts camelCase because it’s a regular JavaScript function or exported helper.

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

Status: In Progress

Development

Successfully merging this pull request may close these issues.

[add] content to add to contributing.md

3 participants