Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refine CONTRIBUTING.md #631

Open
koppor opened this issue Oct 24, 2022 · 0 comments
Open

Refine CONTRIBUTING.md #631

koppor opened this issue Oct 24, 2022 · 0 comments

Comments

@koppor
Copy link
Owner

koppor commented Oct 24, 2022

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:
  4. copy CONTRIBUTING.md to docs/contributing.md
  5. Add nav: header to docs/contributing.md

  • We accept that the "Edit" button on the contributing guide does not work any more.
  • We follow the GitHub approach to have CONTRIBUTING.md at the main folder
  • We don't want to have two CONTRIBUING.md files
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant