CONTRIBUTING.md #6

New issue

Closed

opened 2025-11-03 13:24:52 +01:00 by puer-robustus · 4 comments

puer-robustus commented

2025-11-03 13:24:52 +01:00

Member

As a newcomer it is hard to judge, what the "right" way to contribute to the project is.

I suggest adding a CONTRIBUTING.md file which outlines to newcomers

how to setup the repo locally (incl. its dependencies),
how the different .ts files which a contributor might want to adapt are related, and
what the git workflow is (direct pushes, PRs via branches, PRs via forks),

Alternatively, the existing README.md could be extended with this type of documentation.

As a newcomer it is hard to judge, what the "right" way to contribute to the project is. I suggest adding a [`CONTRIBUTING.md` file](https://mozillascience.github.io/working-open-workshop/contributing/) which outlines to newcomers * [x] how to setup the repo locally (incl. its dependencies), * [x] how the different `.ts` files which a contributor might want to adapt are related, and * [x] what the git workflow is (direct pushes, PRs via branches, PRs via forks), Alternatively, the existing `README.md` could be extended with this type of documentation.

ilazur was assigned by ijohn

2025-11-09 20:31:10 +01:00

ijohn self-assigned this

2025-11-09 20:32:52 +01:00

ijohn commented

2025-11-09 20:44:54 +01:00

Owner

We should keep the current README in my opinion. Can you @ilazur add point 2 and 3, please?

ijohn referenced this issue from a commit

2025-11-09 21:23:28 +01:00

Feature #6: Improve setup instructions

hernani commented

2025-11-10 17:07:49 +01:00

Member

In context of this, I just added a small note to README.txt (cf. 19c899c039). It's far from fully useful, but might give an idea on which files to consider at least when adding a dossier.

In context of this, I just added a small note to README.txt (cf. 19c899c039283d42366757887c9e7d49b861d99a). It's far from fully useful, but might give an idea on which files to consider at least when adding a dossier.

ilazur referenced this issue from a commit

2025-11-28 14:52:53 +01:00

tech-dossiers/ngi0-landing#6 New Contributing.md file with manual added

ilazur commented

2025-11-28 14:54:47 +01:00

Member

So i added proposed CONTRIBUTING.md with instructions, how to add new dossier. Please review it, if you will have time.

So i added proposed `CONTRIBUTING.md` with instructions, how to add new dossier. Please review it, if you will have time.

puer-robustus referenced this issue from a commit

2025-12-04 23:33:50 +01:00

docs(CONTRIBUTING): improve readability of CONTRIBUTING.md

puer-robustus referenced this issue from a commit

2025-12-04 23:36:48 +01:00

docs(CONTRIBUTING): improve readability of CONTRIBUTING.md

puer-robustus commented

2025-12-04 23:40:17 +01:00

Author

Member

@ilazur Thank you for your work on this: it has clarified a few things for me. Please find my proposed adjustments to the CONTRIBUTING.md file in #15. What do you think about those?

PS: It would have been easier for me to give you feedback, if you had created a PR yourself rather than pushing directly onto master ;)

@ilazur Thank you for your work on this: it has clarified a few things for me. Please find my proposed adjustments to the `CONTRIBUTING.md` file in #15. What do you think about those? PS: It would have been easier for me to give you feedback, if you had created a PR yourself rather than pushing directly onto master ;)

hernani closed this issue

2026-05-02 14:49:31 +02:00