Skip to content

Commit 0d58d18

Browse files
ebouchutCopilot
andauthored
docs: Add missing sections to CONTRIBUTING.md
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent 5dc06d3 commit 0d58d18

1 file changed

Lines changed: 45 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -436,18 +436,63 @@ is available as an [SVG image](https://raw.githubusercontent.com/ebouchut/learn-
436436

437437
### Reporting Bugs
438438

439+
If you encounter a bug, please [open an issue](https://github.com/ebouchut/learn-dev/issues) and include:
440+
441+
- A clear and descriptive title.
442+
- Steps to reproduce the problem (code snippets, commands, or screenshots if relevant).
443+
- What you expected to happen.
444+
- What actually happened (including any error messages).
445+
- Your environment details (OS, browser, Node/Python/runtime versions, etc. if applicable).
446+
447+
This information helps maintainers reproduce and fix the issue more quickly.
439448

440449
### Suggesting Enhancements
441450

451+
We welcome ideas to improve **learn-dev** (new features, UX improvements, performance, documentation, etc.).
452+
Before opening a feature request, please:
453+
454+
- Check the existing [issues](https://github.com/ebouchut/learn-dev/issues) to see if a similar idea already exists.
455+
- Add a comment to an existing issue if it matches your idea, rather than opening a duplicate.
456+
457+
If you open a new enhancement issue, try to explain the problem you are trying to solve, not only the solution you have in mind.
458+
442459
#### Feature Request Template
443460

461+
When creating a feature request issue, you can use the following structure:
462+
463+
- **Summary**: A short description of the feature.
464+
- **Problem**: What problem does this feature solve for users?
465+
- **Proposed solution**: How you think this feature could work (UI/API/behavior).
466+
- **Alternatives**: Any alternative solutions or workarounds you have considered.
467+
- **Additional context**: Screenshots, diagrams, or links that help explain the idea.
468+
444469
### Finding Issues to Work On (good first issue, help wanted)
445470

471+
If you are new to the project, we recommend starting with issues labeled
472+
[`good first issue`](https://github.com/ebouchut/learn-dev/labels/good%20first%20issue) or
473+
[`help wanted`](https://github.com/ebouchut/learn-dev/labels/help%20wanted) on GitHub.
474+
475+
Steps to get started:
476+
477+
- Pick an open issue with one of these labels.
478+
- Comment on the issue to indicate that you would like to work on it.
479+
- Wait for a maintainer to confirm or provide additional guidance before investing a lot of time.
480+
481+
If you are unsure where to start, you can also open an issue asking for pointers or clarification.
446482

447483
## Development Workflow
448484

449485
### Setting Up Your Development Environment
450486

487+
At a high level, you will usually need to:
488+
489+
- Fork the repository and clone your fork locally.
490+
- Follow the setup instructions in the project’s README files (for backend, frontend, or other components).
491+
- Install the required dependencies using the package manager(s) mentioned there.
492+
- Run the test suite or basic checks to ensure everything works before you start making changes.
493+
494+
For more detailed, component-specific instructions, please refer to the corresponding README files in each subdirectory.
495+
451496
### Testing the API with Postman
452497

453498
The repository ships two files under `backend/postman/` that let you

0 commit comments

Comments
 (0)