-
Notifications
You must be signed in to change notification settings - Fork 70
Moved Developers to CONTRIBUTING.md
#543
Conversation
CONTRIBUTING.md
Outdated
| $ python setup.py develop | ||
| $ pip install -r test-requirements.txt | ||
| $ alias atomicapp=<path-to-venv>/venv/bin/atomicapp | ||
| $ alias sudo='sudo ' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
imo, this is too complicated and not friendly for development, we added make install, can't we just use that?
i'd be open to modify Makefile to add a "virtual" environment, ex. make dev as an alternative that we re-iterate what you just put here. saves having modify each alias every time. I'm not too familar to people coding via virtualenv, but giving people the option to do so would be cool
but I'm against this way. each time a person wants to develop they'd have to setup all these aliases again each time plus it's difficult >.>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes will look into Makefile and try to make changes accordingly.
ee67c2e to
e74b67d
Compare
Moved the `Developers` section from README.md to CONTRIBUTING.md This makes easy for a developer to find all the information in one place.
e74b67d to
917b195
Compare
| python setup.py develop; \ | ||
| echo "alias atomicapp=~/.virtualenvs/atomicapp/bin/atomicapp" >> ~/.virtualenvs/atomicapp/bin/postactivate; \ | ||
| echo "alias sudo='sudo '" >> ~/.virtualenvs/atomicapp/bin/postactivate; \ | ||
| echo "unalias atomicapp && unalias sudo" >> ~/.virtualenvs/atomicapp/bin/postdeactivate |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cool 👍
|
@surajssd improve the commit message, and we are good to merge. The first line of your commit message should be a summary of the fix (preferably, less than 60 chars). Followed by an optional summary, and reference to Github issue. |
|
Let's wait for discussion from @dustymabe @goern or @vpavlin I don't think this is the best way to introduce someone to development. At the moment the current workflow is: Instead of running this in a virtualenv. Please don't merge for now. |
|
|
||
| ## Developers | ||
|
|
||
| First of all, fork the [repository](https://github.com/projectatomic/atomicapp) and clone your github repository: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fork [atomicapp](https://github.com/projectatomic/atomicapp) and clone your GitHub repo:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Acknowledged
|
Okay I will wait for others to comment and then we can move ahead. |
|
A few things here. It is much easier for reviews and for reading through change history if you don't move code (or docs in this case) and also change the content in the same commit. It's usually better to copy the code in one commit and then make changes to it in the next. As for the virtualenv stuff. I don't mind having a section that explains how to use it with To summarize:
Also charlie should be getting some changes in for his PR on the readme and they should go in soon so you may want to wait to update this PR til after that. |
|
First off I will wait for the @cdrage 's PR on README once that gets pulled further I will make respective changes. About dividing the changes into 'move' and 'change', should this be accompained with new issue as well? And one suggestion in make file we can make something like 'install for development' with virtualenv and without virtualenv, which ever folks choose viz |
Thanks!
No new issue needed.
perhaps we could go for something like that. I'll review your proposal when you update this PR and we'll see where to go with it. |
|
@cdrage 👍 great work on the docs side. |
Closes issue#542
Moved the
Developerssection from README.md to CONTRIBUTING.mdThis makes easy for a developer to find all the information in one place.