question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Missing Installation and ContributingGuidelines?

See original GitHub issue

I forked and cloned this repo locally, then tried to find the installation procedure. Unfortunately, I did Java coding long ago and thus installing this locally isn’t trivial to me right now, or I didn’t look properly. I think it would be worth while to have a separate file like INSTALL for folks who haven’t written production-level Java code so that they can compile locally. Also, I was checking out PRs and it looks as if there are some conventions like first merging into develop and then when it looks stable, merging that branch with master which is also not trivial. I think a ContributingGuidelines can go a long way.

Any thoughts?

Issue Analytics

  • State:closed
  • Created 6 years ago
  • Reactions:2
  • Comments:8 (7 by maintainers)

github_iconTop GitHub Comments

1reaction
athityakumarcommented, Feb 8, 2018

Acknowledged. I’ll try to send in a PR by this weekend.

Regarding the guideline of submitting all PRs against the develop branch, I think it’d be a good idea to additionally specify this in a .github/PULL_REQUEST_TEMPLATE.md file too. When a new PR is about to be submitted, this template file content is shown as the new PR’s placeholder (default) description and could be more effective in communicating this message across to the contributors.

1reaction
ptrthomascommented, Feb 8, 2018

@pranitbauva1997 @athityakumar great !

do consider submitting a PR for a small doc - and looks like the GitHub standard is a CONTRIBUTING.md file so I have just checked in a placeholder: https://github.com/intuit/karate/blob/develop/CONTRIBUTING.md

One guideline I’d like to mention is all PR-s should be submitted against the develop branch.

edit: added link to GitHub recommendations: https://help.github.com/articles/setting-guidelines-for-repository-contributors/

Read more comments on GitHub >

github_iconTop Results From Across the Web

computervision-recipes/CONTRIBUTING.md at master - GitHub
Best Practices, code samples, and documentation for Computer Vision. - computervision-recipes/CONTRIBUTING.md at master · microsoft/computervision-recipes.
Read more >
Contributing Guide — stumpy 1.11.1 documentation
First, install the dependencies using the From Source Section of the installation instructions. If you are building STUMPY within a conda environment, ...
Read more >
Contributing guide — MNE 1.2.2 documentation
Configuring git​​ To get set up for contributing, make sure you have git installed on your local computer: On Linux, the command sudo...
Read more >
Contributing - PyScaffold 4.3.1 documentation
This guide focus on issue reports, documentation improvements, and code contributions, but there are many other ways to contribute to PyScaffold, even if...
Read more >
Contribution Guide - The Go Programming Language
Step 4: Install the git-codereview command. Changes to Go must be reviewed before they are accepted, no matter who makes the change. A...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found