CONTRIBUTING.md

How to create new tickets in backlog

Before moving a ticket to in progress column

Ask these questions first:

1. Do we have all the necessary info to start it?
2. Have we ever done something similar in the past?
3. What technical challenges we might face in this ticket?
4. Do we care about non-functional requirements?
   • Scalability.
   • Security.
   • Performance.
5. Can we modularize or reuse something?
6. What kind of tests do we need for it?
   • Smoke test.
   • Regression test.
   • Sanity test.
7. Is there other tickets related/connected to this ticket?

Start the application

Run nx dev backend to start the development server. Happy coding!

GitHub actionlint

Husky validates GH actions via actionlint before commit if they were changed or a new one was added:

sudo pacman -Syu actionlint

A rule of thumb on how to edit Technical Glossary:

• Clarity: Add terms that may be ambiguous or subject to interpretation to prevent misunderstanding and conflicts.
• Accessibility: More accessible to a wider audience, including newcomers and may not be familiar with certain technical terminology.
• Consistency: Promoting consistency in communication within this project by ensuring that everyone uses terms in the same way. Fostering a cohesive and inclusive community.
• Reference: Easer to reference key terms as needed, without having to search for definitions elsewhere.
• Transparency: It is a sign of commitment to transparency and clarity in this project's governance and communication practices.

How to tests

• Run nx appOrPkgName test for unit test.
• Learn about Nx here.

Testing strategy

• We are gonna follow -- Extract the essence of these posts and videos and jot it down here and keep these links as reference.
• Kent C. Dodds - How to know what to test?
• Kent C. Dodds - Effective Snapshot Testing
• Kent C. Dodds - Write tests. Not too many. Mostly integration
• Should you test child components or parent components? Or both?
  • Test the happy path (which you could treat as the default path) in the parent component which will capture the behaviour of the child components in the default state.
  • Logic inside the child component that changes the behaviour/UI of the child component due to a non-default prop value, capture that in the child component's test file.
• Static vs Unit vs Integration vs E2E Testing for Frontend Apps
• Confident React - Frontend Testing with Kent C. Dodds