koppor / jabref

Collection of simple for JabRef issues. Please submit PRs to https://github.com/jabRef/jabref/.
https://github.com/jabRef/jabref/
MIT License
8 stars 13 forks source link

Refine CONTRIBUTING.md #631

Open koppor opened 1 year ago

koppor commented 1 year ago

We vote for proposal A

Proposal A:

Change CONTRIBUTING.md:

# Contributing

1. I am a programmer: Please go to <https://devdocs.jabref.org/contributing>.
2. I am not a programmer: Please go to <https://docs.jabref.org/contributing>.
  1. Refine docs/contributing.md
    • Add TOC
    • Add the "two reviewer" thing of the former CONTRIBUTING.md

Proposal B:

  1. Delete CONTRIBUTING.md
  2. Refine docs/contributing.md

We accept that we are not in line with "good repository" guidelines.


Proposal C:

  1. Move docs/contributing.md to CONTRIBUTING.md
  2. Refine CONTRIBUTING.md (add TOC, ...)
  3. Change devdocs publishing process:
    1. copy CONTRIBUTING.md to docs/contributing.md
    2. Add nav: header to docs/contributing.md