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

Add links to contribution guidelines using Githubs infrastructure #26

Open
gavanderhoorn opened this issue Apr 16, 2014 · 11 comments
Open

Add links to contribution guidelines using Githubs infrastructure #26

gavanderhoorn opened this issue Apr 16, 2014 · 11 comments
Labels
enhancement

Comments

@gavanderhoorn
Copy link
Member

Github parses CONTRIBUTING(.md) files in repositories and displays a link to such a file at the top of all pull requests and the new issue page (see [1]).

We could use this to direct people to the ROS-I coding and pull request standards / guidelines.
@gavanderhoorn gavanderhoorn mentioned this issue Jun 25, 2015
Merged
@gavanderhoorn
Copy link
Member Author

Related: #39.

@gavanderhoorn gavanderhoorn mentioned this issue Aug 11, 2017
Open
tfoote added a commit to tfoote/industrial_core that referenced this issue Jul 11, 2018
@tfoote
Create CONTRIBUTING.md
d3b8089 
re: ros-industrial/ros_industrial_issues#26
@tfoote tfoote mentioned this issue Jul 11, 2018
Merged
tfoote added a commit to tfoote/industrial_ci that referenced this issue Jul 12, 2018
@tfoote
Create CONTRIBUTING.md
42195a4 
re: ros-industrial/ros_industrial_issues#26
@tfoote tfoote mentioned this issue Jul 12, 2018
Open
tfoote added a commit to tfoote/industrial_training that referenced this issue Jul 12, 2018
@tfoote
Create CONTRIBUTING.md
9a00f23 
re: ros-industrial/ros_industrial_issues#26
@tfoote tfoote mentioned this issue Jul 12, 2018
Merged
tfoote added a commit to tfoote/keyence_experimental that referenced this issue Jul 12, 2018
@tfoote
Create CONTRIBUTING.md
63a6b6b 
re: ros-industrial/ros_industrial_issues#26
@tfoote tfoote mentioned this issue Jul 12, 2018
Merged
tfoote added a commit to tfoote/universal_robot that referenced this issue Jul 12, 2018
@tfoote
Create CONTRIBUTING.md
bd80c8e 
re: ros-industrial/ros_industrial_issues#26
@tfoote tfoote mentioned this issue Jul 12, 2018
Merged
tfoote added a commit to tfoote/fanuc_experimental that referenced this issue Jul 12, 2018
@tfoote
Create CONTRIBUTING.md
4fedcd9 
re: ros-industrial/ros_industrial_issues#26
@tfoote tfoote mentioned this issue Jul 12, 2018
Merged
tfoote added a commit to tfoote/fanuc that referenced this issue Jul 12, 2018
@tfoote
Create CONTRIBUTING.md
1a7e346 
re: ros-industrial/ros_industrial_issues#26
@tfoote tfoote mentioned this issue Jul 12, 2018
Merged
tfoote added a commit to tfoote/staubli that referenced this issue Jul 12, 2018
@tfoote
Update CONTRIBUTING.md
7ed0bb4 
re: ros-industrial/ros_industrial_issues#26
@tfoote tfoote mentioned this issue Jul 12, 2018
Merged
tfoote added a commit to tfoote/staubli_experimental that referenced this issue Jul 12, 2018
@tfoote
Update CONTRIBUTING.md
bddc05c 
re: ros-industrial/ros_industrial_issues#26
@tfoote tfoote mentioned this issue Jul 12, 2018
Merged
tfoote added a commit to tfoote/ros_canopen that referenced this issue Jul 12, 2018
@tfoote
Create CONTRIBUTING.md
c50f1c4 
re: ros-industrial/ros_industrial_issues#26
@tfoote tfoote mentioned this issue Jul 12, 2018
Merged
tfoote added a commit to tfoote/robotiq that referenced this issue Jul 12, 2018
@tfoote
Create CONTRIBUTING.md
a5f8e29 
re: ros-industrial/ros_industrial_issues#26
@tfoote tfoote mentioned this issue Jul 12, 2018
Merged
tfoote added a commit to tfoote/motoman that referenced this issue Jul 12, 2018
@tfoote
Create CONTRIBUTING.md
02e4ff5 
re: ros-industrial/ros_industrial_issues#26
@tfoote tfoote mentioned this issue Jul 12, 2018
Merged
tfoote added a commit to tfoote/abb_librws that referenced this issue Jul 12, 2018
@tfoote
Create CONTRIBUTING.md
a7a8ce7 
re: ros-industrial/ros_industrial_issues#26
@tfoote tfoote mentioned this issue Jul 12, 2018
Closed
@tfoote
Copy link

tfoote commented Jul 12, 2018

I've opened PRs to add or update CONTRIBUTING.md to all the repos that have been recently touched.

mathias-luedtke pushed a commit to ros-industrial/ros_canopen that referenced this issue Jul 12, 2018
@tfoote @mathias-luedtke
Create CONTRIBUTING.md
410984d 
re: ros-industrial/ros_industrial_issues#26
@tfoote
Copy link

tfoote commented Jul 12, 2018

A good suggestion that this should be generally updated to mention the new Github review process: ros-industrial/abb#153 (review)

@tfoote
Copy link

tfoote commented Jul 12, 2018

The content I submitted was: https://gist.github.com/tfoote/9f38576e148c82f86aa7e6871104a77f

It's a markdown version of https://rosindustrial.org/developmentprocess/

I'm not going to have time to follow up on most of these after wrid18.

Levi-Armstrong pushed a commit to ros-industrial/industrial_training that referenced this issue Jul 16, 2018
@tfoote @Levi-Armstrong
Create CONTRIBUTING.md
4a77eff 
re: ros-industrial/ros_industrial_issues#26
@gavanderhoorn
Copy link
Member Author

everyone in ROS-I: could you hold off on merging the PRs submitted by @tfoote? As commented in ros-industrial/abb#153 (review), the PRs are based on the Development Process page, but that hasn't been updated to use the 'new' Github review system.

Levi-Armstrong pushed a commit to ros-industrial/ros_qtc_plugin that referenced this issue Jul 19, 2018
@tfoote @Levi-Armstrong
Create CONTRIBUTING.md
34fe086 
re: ros-industrial/ros_industrial_issues#26
@shaun-edwards
Copy link
Member

I'm inclined to accept the PRs as is. The steps are in spirit of Github AND having a CONTRIBUTING file is better than not having it. It looks like @Levi-Armstrong has already moved forward with @tfoote's version.

@gavanderhoorn
Copy link
Member Author

Yes, but we've also received comments by community members (such as those in ros-industrial/abb#153 (review)) that are valid.

And I don't necessarily agree that having a CONTRIBUTING.md is better than not having one: having a process is important. The file itself is not.

@mathias-luedtke
Copy link
Member

It might have been better to agree one a consolidated version beforehand in a central place.
(Same story as with #55)

We could discuss an improved version now, however not spread in 20+ PRs.
I would suggest to open one PR in a (to be created?) repository with common templates etc.
After a reasonable amount of time (2 weeks?) we could update the other PRs based on this new template.

@tfoote
Copy link

tfoote commented Jul 31, 2018

A draft was precirculated in the wrid2018 IRC prior to posting. But no one caught that the last paragraph was out of date.
Note that the file itself is somewhat important as Github uses it in it's user interaction prompts which will help new and learning contributors.

@gavanderhoorn
Copy link
Member Author

@ipa-mdl wrote:

I would suggest to open one PR in a (to be created?) repository with common templates etc.

Would that be something you would be willing to do @ipa-mdl?

I can create the repository for you.

@ipa-nhg ipa-nhg mentioned this issue Sep 6, 2018
Open
@gavanderhoorn
Copy link
Member Author

Unassigning @tfoote as it's no longer his task.

Thanks @tfoote for all the PRs.

We'll need to take a good look at this during wrid19, so marking this issue as one for that day.

gavanderhoorn pushed a commit to ros-industrial/abb_experimental that referenced this issue Sep 18, 2019
@tfoote @gavanderhoorn
Update CONTRIBUTING.md (#101)
cfc1bf6 
re: ros-industrial/ros_industrial_issues#26
gavanderhoorn pushed a commit to ros-industrial/universal_robot that referenced this issue Sep 18, 2019
@tfoote @gavanderhoorn
Create CONTRIBUTING.md (#368)
5eca4e6 
re: ros-industrial/ros_industrial_issues#26
gavanderhoorn pushed a commit to ros-industrial/motoman that referenced this issue Sep 18, 2019
@tfoote @gavanderhoorn
Create CONTRIBUTING.md (#231)
cc7d9d9 
re: ros-industrial/ros_industrial_issues#26
gavanderhoorn pushed a commit to ros-industrial/kuka_experimental that referenced this issue Sep 18, 2019
@tfoote @gavanderhoorn
Create CONTRIBUTING.md (#138)
8c41ccc 
re: ros-industrial/ros_industrial_issues#26
gavanderhoorn pushed a commit to ros-industrial/staubli that referenced this issue Sep 18, 2019
@tfoote @gavanderhoorn
Update CONTRIBUTING.md (#27)
c66ef1a 
re: ros-industrial/ros_industrial_issues#26
gavanderhoorn pushed a commit to ros-industrial/staubli_experimental that referenced this issue Sep 18, 2019
@tfoote @gavanderhoorn
Update CONTRIBUTING.md (#29)
b1b1e01 
re: ros-industrial/ros_industrial_issues#26
gavanderhoorn pushed a commit to ros-industrial/fanuc_experimental that referenced this issue Sep 18, 2019
@tfoote @gavanderhoorn
Create CONTRIBUTING.md (#40)
810ec69 
re: ros-industrial/ros_industrial_issues#26
gavanderhoorn pushed a commit to ros-industrial/fanuc that referenced this issue Sep 24, 2019
@tfoote @gavanderhoorn
Create CONTRIBUTING.md (#243)
f63a162 
Squashed commits:

* Create CONTRIBUTING.md
    re: ros-industrial/ros_industrial_issues#26
* Fix link to Discourse category.
gavanderhoorn pushed a commit to gavanderhoorn/universal_robot that referenced this issue Jun 9, 2020
@tfoote @gavanderhoorn
Create CONTRIBUTING.md (ros-industrial#368)
b58a5b7 
re: ros-industrial/ros_industrial_issues#26
gavanderhoorn pushed a commit to ros-industrial/motoman_experimental that referenced this issue Jul 30, 2020
@tfoote
Create CONTRIBUTING.md (#40)
18ed5ed 
re: ros-industrial/ros_industrial_issues#26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Milestone
No milestone
Development

No branches or pull requests
4 participants
@tfoote @mathias-luedtke @shaun-edwards @gavanderhoorn