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

WIP: Begin contributing document #1377

Merged
merged 9 commits into from Jul 30, 2018

Conversation

@odow
Copy link
Member

commented Jul 26, 2018

Closes #1376

@odow odow changed the title Begin contributing document WIP: Begin contributing document Jul 26, 2018

@codecov

This comment has been minimized.

Copy link

commented Jul 26, 2018

Codecov Report

Merging #1377 into master will increase coverage by 0.37%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1377      +/-   ##
==========================================
+ Coverage   89.54%   89.92%   +0.37%     
==========================================
  Files          24       25       +1     
  Lines        3416     3741     +325     
==========================================
+ Hits         3059     3364     +305     
- Misses        357      377      +20
Impacted Files Coverage Δ
src/variables.jl 87.82% <0%> (-0.8%) ⬇️
src/sd.jl 100% <0%> (ø) ⬆️
src/sets.jl 100% <0%> (ø)
src/quadexpr.jl 92.5% <0%> (+0.09%) ⬆️
src/affexpr.jl 97.58% <0%> (+0.12%) ⬆️
src/macros.jl 90.53% <0%> (+0.66%) ⬆️
src/nlp.jl 82.05% <0%> (+2.49%) ⬆️
src/JuMP.jl 82.06% <0%> (+3.76%) ⬆️
src/print.jl 85.65% <0%> (+5.13%) ⬆️

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 75789a7...5de3b49. Read the comment docs.

Questions posted to Discourse have broader visibility and are likely to be
answered more quickly than Github issues.

- If you're experiencing a bug that is solver-specific (e.g., it only happens

This comment has been minimized.

Copy link
@blegat

blegat Jul 26, 2018

Member

Not a native but I have read that "you are" should be used rather than "you're" in written English

@mohamed82008

This comment has been minimized.

Copy link
Contributor

commented Jul 26, 2018

Contributing examples and to the documentation?

@mohamed82008

This comment has been minimized.

Copy link
Contributor

commented Jul 26, 2018

What happens after opening the issue? What if the potential contributor is willing to fix this issue by a PR. There needs to be some recommendations for making a PR. I can think of the following:

  1. Follow the style guide,
  2. Add tests and documentation for any changes or new features,
  3. Discuss any big changes in the issue before spending too much time on it to test the waters first and see if other contributors are fine with these changes or not,
  4. Be patient and polite; you may get ALOT of comments on your PR!

Also, I see no mention of the Gitter channel, is that to cut down the noise there or a general disinterest in making Gitter the "official" go to channel?

@mlubin

This comment has been minimized.

Copy link
Member

commented Jul 26, 2018

Follow the style guide,
Add tests and documentation for any changes or new features,
Discuss any big changes in the issue before spending too much time on it to test the waters first and see if other contributors are fine with these changes or not,
Be patient and polite; you may get ALOT of comments on your PR!

These are all good points that should be included.

Also, I see no mention of the Gitter channel, is that to cut down the noise there or a general disinterest in making Gitter the "official" go to channel?

For me, the Gitter is the "official" channel for development questions (it's listed on the README). So yes, it should be mentioned.


Another way to contribute to JuMP is to file [bug reports](https://github.com/JuliaOpt/JuMP.jl/issues/new?template=bug_report.md).

Before you do however, make sure you read the following before posting a new bug

This comment has been minimized.

Copy link
@mlubin

mlubin Jul 26, 2018

Member

This repeats the same points from the bug report template. We can refer to that instead.


## Write examples

Another way to contribute to JuMP is to add examples. The easiest way to do this

This comment has been minimized.

Copy link
@mlubin

mlubin Jul 27, 2018

Member

The structure for examples is a bit up in the air now (#1175), so I'm not sure if we're ready to accept new ones at this point.

2. Discuss (in the issue, or on [Gitter](https://gitter.im/JuliaOpt/JuMP-dev))
_before_ spending too much time on it to test the waters first and see if other
contributors are fine with these changes or not
3. Make your changes locally. (The Julia manual has a [guide ](https://docs.julialang.org/en/stable/manual/packages/#Making-changes-to-an-existing-package-1)

This comment has been minimized.

Copy link
@mlubin

mlubin Jul 27, 2018

Member

Nit: extra space in [guide ]

4. Submit a pull request to Github
5. Update your pull request, responding to any comments

Remember to be patient and polite; you may get _alot_ of comments on your PR!

This comment has been minimized.

Copy link
@mlubin

mlubin Jul 27, 2018

Member

Nit: "alot" -> "a lot"

4. Submit a pull request to Github
5. Update your pull request, responding to any comments

Remember to be patient and polite; you may get a _lot_ of comments on your PR!

This comment has been minimized.

Copy link
@mlubin

mlubin Jul 29, 2018

Member

"PR" isn't defined in the text.

@mlubin

This comment has been minimized.

Copy link
Member

commented Jul 29, 2018

GitHub suggests linking to the code of conduct.

@mlubin

This comment has been minimized.

Copy link
Member

commented Jul 29, 2018

Also cross link from https://github.com/JuliaOpt/JuMP.jl/blob/master/CODE_OF_CONDUCT.md#get-involved (which currently says "We haven't yet put together a guide for new contributors ...").

@mlubin

This comment has been minimized.

Copy link
Member

commented on .github/CONTRIBUTING.md in 5dcba3c Jul 29, 2018

This last sentence is a bit of a downer. Can we just drop it? The code of conduct already discusses the community stewards.

@mlubin

This comment has been minimized.

Copy link
Member

commented on 5dcba3c Jul 29, 2018

The code of conduct and the contributing guide should both be in the same directory. Either the root or .github seems fine to me.

This comment has been minimized.

Copy link
Member Author

replied Jul 29, 2018

Github says it needs to be in docs or .github

This comment has been minimized.

Copy link
Member

replied Jul 29, 2018

"your project repository's root, docs, or .github folder."

This comment has been minimized.

Copy link
Member Author

replied Jul 29, 2018

I'm blind...

@mlubin

This comment has been minimized.

Copy link
Member

commented on CODE_OF_CONDUCT.md in 5dcba3c Jul 29, 2018

Is there a way to use relative links instead of pointing to the master branch?

@odow

This comment has been minimized.

Copy link
Member Author

commented Jul 29, 2018

Yeah I just copied Atom

@mlubin

This comment has been minimized.

Copy link
Member

commented Jul 29, 2018

LGTM now. Let's get a few more eyeballs.


A third way to contribute to JuMP is to file [bug reports](https://github.com/JuliaOpt/JuMP.jl/issues/new?template=bug_report.md).

(Make sure you read the info in the box where you write the body of the issue

This comment has been minimized.

Copy link
@blegat

blegat Jul 29, 2018

Member

Isn't weird to put a whole paragraph in parenthesis ?


Finally, you can also contribute code to JuMP!

If you don't have experience with Git, Github, and Julia development, the first

This comment has been minimized.

Copy link
@blegat

blegat Jul 29, 2018

Member

don't -> do not

If you don't have experience with Git, Github, and Julia development, the first
steps can be a little daunting. However, there are lots of tutorials available
online (such as [this](http://try.github.io/), [this](https://guides.github.com/activities/hello-world/),
and [this](https://docs.julialang.org/en/stable/manual/packages/#Making-changes-to-an-existing-package-1)).

This comment has been minimized.

Copy link
@blegat

blegat Jul 29, 2018

Member

Maybe also Git Real of code school and the git-book

1. Find an [open issue](https://github.com/JuliaOpt/JuMP.jl/issues) (or open a
new one) for the problem you want to solve
2. Discuss (in the issue, or on [Gitter](https://gitter.im/JuliaOpt/JuMP-dev))
_before_ spending too much time on it to test the waters first and see if other

This comment has been minimized.

Copy link
@blegat

blegat Jul 29, 2018

Member

Missing indent

_before_ spending too much time on it to test the waters first and see if other
contributors are fine with these changes or not
3. Make your changes locally. (The Julia manual has a [guide](https://docs.julialang.org/en/stable/manual/packages/#Making-changes-to-an-existing-package-1)
on how to do this.) Make sure you:

This comment has been minimized.

Copy link
@blegat

blegat Jul 29, 2018

Member

Missing indent

@blegat

blegat approved these changes Jul 29, 2018

on how to do this.)

If your change is larger, or touches multiple files, you will need to make the
change locally and then use Git to submit a pull request. (See [Contribute code to JuMP](#Contribute code to JuMP)

This comment has been minimized.

Copy link
@mohamed82008

mohamed82008 Jul 29, 2018

Contributor

This shows up in a funny way in the file, not sure what the fix is if any is needed.

new one) for the problem you want to solve
2. Discuss (in the issue, or on [Gitter](https://gitter.im/JuliaOpt/JuMP-dev))
_before_ spending too much time on it to test the waters first and see if
other contributors are fine with these changes or not

This comment has been minimized.

Copy link
@mohamed82008

mohamed82008 Jul 29, 2018

Contributor

Discuss what and which changes?

@mlubin

This comment has been minimized.

Copy link
Member

commented Jul 30, 2018

Seems good enough to merge. Can be tweaked further as needed.

@mlubin

This comment has been minimized.

Copy link
Member

commented Jul 30, 2018

Thanks @odow !

@mlubin mlubin merged commit c27c7fc into master Jul 30, 2018

5 checks passed

codecov/patch Coverage not affected when comparing 75789a7...5de3b49
Details
codecov/project 89.92% (+0.37%) compared to 75789a7
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details

@mlubin mlubin deleted the contributing branch Jul 30, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.