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

[docs] move contributing guide to docs and expand #2743

Merged
merged 6 commits into from
Oct 11, 2021
Merged

Conversation

odow
Copy link
Member

@odow odow commented Oct 11, 2021

Closes #2675

I'll add a preview link once the build finishes.

Preview: https://jump.dev/JuMP.jl/previews/PR2743/developers/contributing/

@codecov
Copy link

codecov bot commented Oct 11, 2021

Codecov Report

Merging #2743 (54ef2bd) into master (3100dee) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2743   +/-   ##
=======================================
  Coverage   93.91%   93.91%           
=======================================
  Files          44       44           
  Lines        5568     5568           
=======================================
  Hits         5229     5229           
  Misses        339      339           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3100dee...54ef2bd. Read the comment docs.

@pulsipher
Copy link
Contributor

This is a nice improvement. One suggestion would be to consider adding in a guide for using a GUI interface (e.g., VSCode) to contribute. This removes the need to use the terminal to check out environments and use git which lowers the barrier for contributors that are comfortable with creating Julia scripts, but not running shell commands. Sadly, my current workload won't permit me to make such a contribution myself.

One other suggestion, might be to mention that the tests can be run via including the runtests.jl file directly in an active REPL, so that they can be run multiple times much faster. Naturally, this needs to be done cautiously, but it is a nice way to debug tests quickly.

@odow
Copy link
Member Author

odow commented Oct 11, 2021

One suggestion would be to consider adding in a guide for using a GUI interface

I haven't used the VS code interface, so I'm not in a strong position to do this. I suggest we leave as-is for this PR, and improve things later if there is demand.

docs/src/developers/contributing.md Outdated Show resolved Hide resolved
docs/src/developers/contributing.md Outdated Show resolved Hide resolved
docs/src/developers/contributing.md Outdated Show resolved Hide resolved
docs/src/developers/contributing.md Outdated Show resolved Hide resolved
docs/src/developers/contributing.md Outdated Show resolved Hide resolved
docs/src/developers/contributing.md Show resolved Hide resolved
@odow
Copy link
Member Author

odow commented Oct 11, 2021

I'll merge for now. If anyone has other suggestions, please open a PR or an issue.

@odow odow merged commit 7d58b7f into master Oct 11, 2021
@odow odow deleted the od/contributing branch October 11, 2021 21:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

Documentation improvements
4 participants