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

doc: simplify contributing guidelines and improve the visibility to contributors #320

Merged
merged 11 commits into from
Sep 10, 2021

Conversation

haowang-bioinfo
Copy link
Member

@haowang-bioinfo haowang-bioinfo commented Sep 8, 2021

Main improvements in this PR:

  • improve the contributing guidelines in Human-GEM
    • remove the section of git commands, which are no longer necessary after the implementation of yaml workflow
    • increase visibility of contributing section in README by moving it to top
    • move annotation file details from main README to that under model directory

I hereby confirm that I have:

  • Tested my code on my own computer for running the model
  • Selected develop as a target branch

@haowang-bioinfo haowang-bioinfo changed the title doc: simplify contributing guidelines to adapt with yaml workflow doc: simplify contributing guidelines and improve the visibility to contributors Sep 8, 2021
Copy link
Member

@mihai-sysbio mihai-sysbio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks nice. I have left some minor suggests here and there, feel free to adapt/reject.

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
haowang-bioinfo and others added 3 commits September 9, 2021 08:27
Co-authored-by: Mihail Anton <mihail.anton@chalmers.se>
Co-authored-by: Mihail Anton <mihail.anton@chalmers.se>
Co-authored-by: Mihail Anton <mihail.anton@chalmers.se>
@JonathanRob
Copy link
Collaborator

Thanks for these nice changes, @Hao-Chalmers

Since we're on the topic of the README, can I suggest that the tables in the Reaction, Metabolite, and Gene Annotations section are moved to a separate README within the model directory (where the annotation files reside)? The reason is that they make the README pretty long, and such detail may not be necessary in the main README.

@haowang-bioinfo
Copy link
Member Author

haowang-bioinfo commented Sep 9, 2021

@JonathanRob good idea, go ahead (in this branch)

@haowang-bioinfo haowang-bioinfo merged commit 31ad2a5 into develop Sep 10, 2021
@haowang-bioinfo haowang-bioinfo deleted the fix/updateReadme branch September 10, 2021 06:17
@haowang-bioinfo haowang-bioinfo mentioned this pull request Sep 10, 2021
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

Successfully merging this pull request may close these issues.

3 participants