Adding local env setup and pull request sections to 'CONTRIBUTING.md' #167
Conversation
…TING.md'. Related to #60
|
Great first craft. Was just in the process of something similar. One comment; can you define for what OS the |
Git 1.9.4 preview from their downloads comes with an optional bash shell so most everything that I've found there is identical to Linux... no need to download cygwin anymore I think. Mac is the one that I have no idea what it looks like with git since that machine has gone to Valhalla... it is probably the same but would be nice to know for sure. |
|
Think he means the download locations. Windows/OS X deffinitely don't have sudo/apt-get. Btw, what version of Ruby? 1.x or 2.x? |
|
heh... I think the devs at GH are playing... the whole content of all main issue bodies is missing when running a wide script. :\ |
|
After some quick searching I've added links to RubyInstaller for Windows users. Also mentioned Windows users will need to kick off FakeS3 manually... not really sure what that process would look like. |
|
What would be the Mac equivalent of the commands, etc.? |
|
Installing MongoDB locally isn't really needed since I have a dev DB already setup and configured. Do we want to encourage new devs to use their own DB or should the guide state that this is optional? |
Depends on how advanced the contributor is... I am interested but you are right the dev db is a good common starting point. Maybe an advanced section?
Well I know they have a bash similar shell too but packages and stuff... I never did that other than .dmg files. |
|
Some slightly older versions of
Is the d switch necessary? I've never used it and it seems to get all the dependencies here... nor is it listed in my $ npm -v
1.4.3 |
It's a poorly named flag when you find the stackoverflow link already purple on Google... https://stackoverflow.com/questions/8783230/what-is-the-d-in-npm-d-install
|
Very... tried using |
* Using own MongoDB instance is optional * SSH clone URL for old client compatibility * Omit '-d' from 'npm install' of dependencies * Improving Ruby install section and added Mac
|
Updated with fa09c19 |
The Windows portion of this sentence is still baffling me... do you mean open up Command Prompt window or git preview instance (assuming this is possible and I'm not on my Win box now) ? |
Yes, for Windows it'd involve opening a command prompt and manually running the command(s) contained in fakes3.sh, which is currently just |
|
Actually, adding a |
I didn't get this far in Windows the other day but I installed the latest git with the git bash option which gives me a bash terminal. I just checked that it can run two instances... It should run .sh scripts directly I think... confirmed it does. Since we all need the git scm exe for contributing under Windows should we focus on that rather than making .bat files (which may eventually be deprecated due to .cmd and powershell ... but with M$ one never knows for sure behind the closed doors or is that gates? ;) ) |
Agreed. Does that command need to be modified at all to run on windows (fakes3.exe?)? The only time I built OUJS on windows I used cygwin. |
|
Installing the gem creates a |
Oh good! That means we don't have to maintain that code and in the docs too. phew :)
Needs confirmation. |
edit: If you were saying the "command stays the same" needs testing, I had already tested it. Regarding the Ruby bin being in the system PATH:
|
Your screen image is perfect for confirmation. Thank you. Although you did say:
... which implies that we should not be creating a .bat file as proposed in #176 since it's already done by those maintainers instead of us. Did I miss your intention? Just a note too I'm not against this if we need it since we have a .sh script to do the same thing. The gem here does not export anything .sh related to the env path by default for Linux ... but if it's already in the ruby directory and pathed why bother for Windows? |
The "fakes3.bat" in the Ruby bin is equivalent to the |
Okay... awesome and thank you for the clarification. :) |
Reiterated from Zren... Which Ruby version for Windows? have quite a few current choices...: My Nix distro is using 1.9.3 soooo assuming this one? |
|
Feel free to use the modified document as-is or base something else off of the content I wrote. Rather not argue over trivialities. |
Adding local env setup and pull request sections to 'CONTRIBUTING.md'
Thank you for giving us a good starting point. It was something that was desperately needed. If someone wishes to modify the document, they can open a PR with their own proposed changes. |
Applies to OpenUserJS#60 and OpenUserJS#167
Applies to OpenUserJS#240, OpenUserJS#167 and OpenUserJS#60
* Applies to OpenUserJS#240, OpenUserJS#167 and OpenUserJS#60
Applies to OpenUserJS#240, OpenUserJS#167 and OpenUserJS#60
* More descript elaboration * Some spelling corrections.. ran it through a spell checker. * Removed `upstream` label ref and question * Changed `console` to `terminal` since console is more KDE oriented and terminal is more X oriented. e.g. devoid of Window Manager. Applies to OpenUserJS#240, OpenUserJS#167 and OpenUserJS#60
…used together. * e.g. let the hosting site resolve those. Applies to OpenUserJS#240, OpenUserJS#167, OpenUserJS#116, and OpenUserJS#60
Applies to OpenUserJS#240, OpenUserJS#167, OpenUserJS#116, and OpenUserJS#60
Taking a stab at getting the dev setup process documented for #60.