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

Adding Documentation #1

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Adding Documentation #1

wants to merge 2 commits into from

Conversation

EnelaSefer
Copy link
Collaborator

I added some documentation, please check the contents.

@EnelaSefer EnelaSefer added the documentation Improvements or additions to documentation label Jan 8, 2025
@EnelaSefer EnelaSefer requested a review from hasic-haris January 8, 2025 20:36
@hasic-haris
Copy link
Contributor

hasic-haris commented Jan 9, 2025

The documentation is the gist of this repository, so the formatting should be as strict as possible. Here are some guidelines that should be followed, which are not consistent in this PR:

  1. Names of Files: The correct format is YYYYMMDD_authors. As far as the date goes, it should always be the publication date of the reference. As for the authors, it should always be the first author only except in the case of only one or two authors. For example: 20250109_hasic_h_et_al (et al. means and others), 20250109_hasic_h_and_sefer_e_m (if your name and middle name are Enela Mukelefa Sefer), and 20250109_sefer_e_m.
  2. Contents of Files: The title should be capitalized appropriately. For exmaple: "Integrating Synthetic Accessibility with AI-based Generative Drug Design". Here, every word is capitalized, except of prepositons and similar smaller words. Additionally, words separated with a hyphen are capitalized at the beginning and not afterwards. The names of authors should be separated by ", " and nothing else. Additionally, only the first and surname are spelled out using original characters, and middle names are abbreviated with ".". Please check the names of the journals again. For example, "BMC Journal of Cheminformatics", "ACS JCIM", etc. There are no alternative publication links anywhere. This can be done by simply Googling the title and looking if there is an open-source alternative where people can download the reference file, like PubMed, ResearchGate, arXiv, ChemRxiv, etc. The abstract is just copy pasted. Plese insert line breaks at a length of 120 characters, PyCharm should have a visual divider.
  3. Contents of the README.md File: The reference index should contain a link to the appropriate file. The names of the authors should be separated by ", " and ", and " or " and " for the last author. The title should be appropriately capitalized as previously described and marked as bold. The abbreviation of the journal can be found at the journal source, and should be italicized. The year, journal volume, number, pages follow normally.

Please check these points in your PR and let's check in again once that is done. If you want additional examples of these instructions, please check out the references directory in the data-source repository. And at the end I want to stress the importance of precision and following the guidelines as strict as possible without errors or spelling mistakes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants