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.

Sign up for GitHub

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

Jump to bottom

docs: Detail project setup and contributing workflow #8

Merged
merged 4 commits into from
Oct 1, 2019
Merged

docs: Detail project setup and contributing workflow #8

merged 4 commits into from
Oct 1, 2019

Conversation

x0s
Copy link
Contributor

@x0s x0s commented Oct 1, 2019

This PR aims at facilitating new contributors to join the project by:

  • explaining how to set up a well-encapsulated virtual environment for development.
  • providing a step-by-step guide how to contribute to the project

Any feedback is welcome, thanks for reviewing

@x0s x0s requested a review from frgfm October 1, 2019 16:44
@frgfm frgfm added the topic: documentation Improvements or additions to documentation label Oct 1, 2019
@frgfm frgfm changed the title Detail project setup and contributing workflow docs: Detail project setup and contributing workflow Oct 1, 2019
frgfm
frgfm approved these changes Oct 1, 2019
View reviewed changes
Copy link
Member

@frgfm frgfm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR adds detailed explanations for contributors in the existing documentation. Potential future edit to make once 0.1.0 is reached: suggesting PR to a new dev branch, which then will be regularly merged into master.

@frgfm frgfm marked this pull request as ready for review October 1, 2019 19:20
@frgfm frgfm assigned x0s and frgfm Oct 1, 2019
@frgfm
Copy link
Member

frgfm commented Oct 1, 2019

CI was not running jobs for PR from forks, which is now fixed

@frgfm frgfm merged commit 1532a34 into pyronear:master Oct 1, 2019
frgfm pushed a commit that referenced this pull request Oct 4, 2019
@x0s @frgfm
docs: Detail project setup and contributing workflow (#8)
a578903 
* Add new table of contents to precise project setup & contributing workflow

* Add explanation on how to create a virtual environment

* Add section to detail how to fork project and install dependencies

* detail step-by-step the current contributing worklow
JoaoFdC pushed a commit to JoaoFdC/PyroNear that referenced this pull request Oct 19, 2019
@x0s @JoaoFdC
docs: Detail project setup and contributing workflow (pyronear#8)
6780425 
* Add new table of contents to precise project setup & contributing workflow

* Add explanation on how to create a virtual environment

* Add section to detail how to fork project and install dependencies

* detail step-by-step the current contributing worklow
blenzi pushed a commit to blenzi/PyroNear that referenced this pull request Oct 21, 2019
@x0s @frgfm
docs: Detail project setup and contributing workflow (pyronear#8)
af54936 
* Add new table of contents to precise project setup & contributing workflow

* Add explanation on how to create a virtual environment

* Add section to detail how to fork project and install dependencies

* detail step-by-step the current contributing worklow
@x0s x0s deleted the detail-project-setup-and-contributing-workflow branch April 1, 2020 14:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@frgfm frgfm frgfm approved these changes

Assignees

@x0s x0s

@frgfm frgfm

Labels
topic: documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@x0s @frgfm