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

Update README: broken link to contributing docs in README, outdated instructions for package usage, commit style guide. #52

Closed
1 of 5 tasks
NMontanaBrown opened this issue Jun 21, 2020 · 2 comments · Fixed by #58
Assignees
Labels
docs Issue related to documentation (reStructredText, Markdown, docstrings)

Comments

@NMontanaBrown
Copy link
Member

NMontanaBrown commented Jun 21, 2020

Issue description

  1. The link to contributions doc is broken - ideally update this so it is not broken anymore.
  2. The instructions for utilisation of the package using argparse could be simplified
  3. Our commit messages are a bit all over the place making it hard to get the gist of updates from commits, implement a commit contrib style guide in CONTRIBUTIONS.
  4. The issue template does not enforce md style of "type of issue". Fix this.
  5. For setup, we have discarded requirements.txt so need to remove this from the readme to avoid confusion.

Type of issue

Please delete options that are not relevant.

  • Bug report
  • New feature request
  • Documentation update
  • Test request
  • Linting request

For bug report or feature request, steps to reproduce the issue, including (but not limited to):

N/A

What's the expected result?

  1. Link no longer broken - direct to master file of CONTRIBUTIONS.md
  2. Reduced, simpler instructions for argparse
  3. Uniform guide in writing for better guidance and more uniform history in dev.
  4. Appropriate md style for title in "Type of issue".
  5. Remove confusing "pip install requirements.txt" when requirements are held in the setup file in the next instruction.

What's the actual result?

  1. 404 Error when clicking on README to the CONTRIBUTIONS.md
  2. N/A
  3. Commit instructions a bit vague - be more explicit in wanted style to facilitate dev.
  4. Literal "# # Type of Issue" returned in md formatting.
  5. We have an instruction for "install requirements.txt" but no txt file in the repo, which is confusing and should be addressed.

Additional details / screenshot

N/A

@NMontanaBrown NMontanaBrown added the docs Issue related to documentation (reStructredText, Markdown, docstrings) label Jun 21, 2020
@NMontanaBrown NMontanaBrown self-assigned this Jun 21, 2020
@YipengHu
Copy link
Member

Could make argparse just an alternative to config file?

NMontanaBrown added a commit that referenced this issue Jun 21, 2020
…nt to master branch version of CONTRIBUTING.md [ci skip]
NMontanaBrown added a commit that referenced this issue Jun 21, 2020
… is the largest, and type of issue second largest header [ci skip]
@NMontanaBrown
Copy link
Member Author

@YipengHu it does avoid the issue of having to generate config files, but I think this is a separate ticket to the one at hand. For this issue, I am working on the main docs of the three command line interfaces (train, predict, gen_tfrecord) since I just recently modified this functionality and I find the docs in README for usage quite confusing (so I cant imagine how confusing for end user!).
But expansion of argparse is potentially warranted! I'll raise a ticket and tag.

NMontanaBrown added a commit that referenced this issue Jun 21, 2020
…ent by removing the requirements.txt instruction and expanding on the instructions for dependency management.
NMontanaBrown added a commit that referenced this issue Jun 21, 2020
… and reduce the repeated argument explanations in predict and train
NMontanaBrown added a commit that referenced this issue Jun 21, 2020
…s to facilitate uniform commit style in history [ci skip]
NMontanaBrown added a commit that referenced this issue Jun 21, 2020
YipengHu added a commit that referenced this issue Jun 25, 2020
YipengHu added a commit that referenced this issue Jun 25, 2020
s-sd pushed a commit that referenced this issue Jul 2, 2020
…nt to master branch version of CONTRIBUTING.md [ci skip]
s-sd pushed a commit that referenced this issue Jul 2, 2020
… is the largest, and type of issue second largest header [ci skip]
s-sd pushed a commit that referenced this issue Jul 2, 2020
…ent by removing the requirements.txt instruction and expanding on the instructions for dependency management.
s-sd pushed a commit that referenced this issue Jul 2, 2020
… and reduce the repeated argument explanations in predict and train
s-sd pushed a commit that referenced this issue Jul 2, 2020
…s to facilitate uniform commit style in history [ci skip]
s-sd pushed a commit that referenced this issue Jul 2, 2020
s-sd pushed a commit that referenced this issue Jul 2, 2020
s-sd pushed a commit that referenced this issue Jul 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issue related to documentation (reStructredText, Markdown, docstrings)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants