create account

Steemit.com GitHub Issue Guidelines - Pull Request Submitted and Approved by timcliff

View this thread on: hive.blog |  peakd.com |  ecency.com
steemit · @timcliff · (edited)
$31.24
Steemit.com GitHub Issue Guidelines - Pull Request Submitted and Approved
The Steemit.com GitHub repository is a very busy place! Developers are busy working on changes, and the community is very involved with discussing and reporting issues. 

Many of the issues that are created are for the same types of things: support requests, enhancement suggestions, and bug reports. The dev team has to spend a lot of time reviewing these issues, and educating people on the correct way to get their issues addressed.

I looked into it, and found a way to create a set of "guidelines for contribution" that would let users know the proper way to use (and not use) the GitHub repository to address their issues.

Over the weekend, I submitted a pull-request to add guidelines to the Steemit.com repository, and this afternoon - the pull reqeust was approved! They now show up when entering an issue into GitHub :)

http://i.imgsafe.org/24db61aa22.png

Here are the guidelines that will show up when users go to create issues:

# Please Read

Please read these instructions before submitting issues to the Steemit.com GitHub repository. The issue tracker is for bugs and specific implementation discussion **only**. It should not be used for other purposes, as described below.

## Bug Reports

If there is an existing feature that is not working correctly, or a glitch in the website that is impacting user behaviour - please open an issue to report variance. Include as much relevant information as you can, including screen shots and steps to reproduce the issue.

## Technical Support and Login Issues

If you are having trouble using the website but it is not an error with the website (this includes login issues), do **not** open a GitHub issue. Please request help from the users in the [steemit.chat help](https://steemit.chat/channel/help) channel.

## Enhancement Suggestions

Do **not** use the issue tracker to suggest enhancements or improvements to the platform. The best place for these discussions is on Steemit.com. If there is a well vetted idea that has the support of the community that you feel should be considered by the development team, please email it to [sneak@steemit.com](mailto:sneak@steemit.com) for review.

## Implementation Discussion

The developers frequently open issues to discuss changes that are being worked on. This is to inform the community of the changes being worked on, and to get input from the community and other developers on the implementation.

Issues opened that devolve into lengthy discussion of minor site features will be closed or locked.  The issue tracker is not a general purpose discussion forum.

This is not the place to make suggestions for product improvement (please see the Enhancement Suggestions section above for this). If you are not planning to work on the change yourself - do not open an issue for it.

## Steemit.com vs. Steem Blockchain

This issue tracker is only intended to track issues for the Steemit.com website. If the issue is with the Steem blockchain, please open an issue in the [Steem Repository](https://github.com/steemit/steem).

## Pull Requests

Anybody in the community is welcome and encouraged to submit pull requests with any desired changes to the platform!

Requests to make changes to steemit.com that include working, tested pull requests jump to the top of the queue. There is not a guarantee that all functionality submitted as a PR will be accepted and merged, however.
👍  , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , and 219 others
properties (23)
authortimcliff
permlinksteemit-com-github-issue-guidelines-pull-request-submitted-and-approved
categorysteemit
json_metadata{"tags":["steemit","dev","development","github"],"image":["http://i.imgsafe.org/24db61aa22.png"],"links":["https://steemit.chat/channel/help","mailto:sneak@steemit.com","https://github.com/steemit/steem"],"app":"steemit/0.1","format":"markdown"}
created2017-02-14 00:32:36
last_update2017-02-14 00:41:00
depth0
children12
last_payout2017-03-17 02:51:45
cashout_time1969-12-31 23:59:59
total_payout_value27.662 HBD
curator_payout_value3.575 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length3,392
author_reputation272,954,445,077,789
root_title"Steemit.com GitHub Issue Guidelines - Pull Request Submitted and Approved"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id2,501,028
net_rshares66,626,623,064,381
author_curate_reward""
vote details (283)
@bitcoiner · 
Fantastic!
👍  
properties (23)
authorbitcoiner
permlinkre-timcliff-steemit-com-github-issue-guidelines-pull-request-submitted-and-approved-20170214t004945054z
categorysteemit
json_metadata{"tags":["steemit"],"app":"steemit/0.1"}
created2017-02-14 00:49:45
last_update2017-02-14 00:49:45
depth1
children0
last_payout2017-03-17 02:51:45
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length10
author_reputation28,017,014,641,958
root_title"Steemit.com GitHub Issue Guidelines - Pull Request Submitted and Approved"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id2,501,123
net_rshares42,469,450,967
author_curate_reward""
vote details (1)
@jlufer · 
Excellent post sir @timcliff very good information, this will be of great help, I hope never to need it.
Reesteemit the post to contribute to the diffusion
👍  
properties (23)
authorjlufer
permlinkre-timcliff-steemit-com-github-issue-guidelines-pull-request-submitted-and-approved-20170214t003920200z
categorysteemit
json_metadata{"tags":["steemit"],"users":["timcliff"],"app":"steemit/0.1"}
created2017-02-14 00:39:24
last_update2017-02-14 00:39:24
depth1
children1
last_payout2017-03-17 02:51:45
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length155
author_reputation1,396,887,100,335,686
root_title"Steemit.com GitHub Issue Guidelines - Pull Request Submitted and Approved"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id2,501,067
net_rshares42,469,450,967
author_curate_reward""
vote details (1)
@timcliff · 
Thanks @jlufer! :)
properties (22)
authortimcliff
permlinkre-jlufer-re-timcliff-steemit-com-github-issue-guidelines-pull-request-submitted-and-approved-20170214t004029192z
categorysteemit
json_metadata{"tags":["steemit"],"users":["jlufer"],"app":"steemit/0.1"}
created2017-02-14 00:40:27
last_update2017-02-14 00:40:27
depth2
children0
last_payout2017-03-17 02:51:45
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length18
author_reputation272,954,445,077,789
root_title"Steemit.com GitHub Issue Guidelines - Pull Request Submitted and Approved"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id2,501,072
net_rshares0
@personz · (edited)
Great post!

I doesn't seem very organised though to leave feature improvements to roam on Steemit.com, there's a lot of duplicate ideas being talked about with authors unaware of each other. For example I saw [this post](https://steemit.com/steemit/@fubar-bdhr/features-that-would-improve-user-experience-on-steemit) a lot of ideas I've seen elsewhere.

It makes sense to have a ticket system for this like on bugs, but which is separate from the bugs so devs don't get distracted by them.

You can easily organise this with projects on GitHub, or even go as far as using something like ZenHub. The obvious drawback is that it make the normal "issues" tab appear messy.Or you can have a separate repo, though that's a bit of a hack.

Alternatively you can run a bespoke system for it. Maybe a new "official" Steem account which posts ideas for voting and discussion? Or a separate system, like Tutanota use to track feature requests, check it out [here](https://tutanota.uservoice.com/forums/237921-general).
👍  
properties (23)
authorpersonz
permlinkre-timcliff-steemit-com-github-issue-guidelines-pull-request-submitted-and-approved-20170214t211956323z
categorysteemit
json_metadata{"tags":["steemit"],"links":["https://steemit.com/steemit/@fubar-bdhr/features-that-would-improve-user-experience-on-steemit","https://tutanota.uservoice.com/forums/237921-general"],"app":"steemit/0.1"}
created2017-02-14 21:19:57
last_update2017-02-14 21:20:54
depth1
children2
last_payout2017-03-17 02:51:45
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length1,009
author_reputation42,452,361,038,560
root_title"Steemit.com GitHub Issue Guidelines - Pull Request Submitted and Approved"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id2,508,638
net_rshares43,380,142,809
author_curate_reward""
vote details (1)
@timcliff · 
Great suggestions :) For now, Steemit is keeping track of what they plan to work on on their end.

A while back I worked on a community wishlist project. It was helpful to organize all the good ideas in one place.
https://steemit.com/steemit-ideas/@timcliff/the-steemit-wish-list-avatars-notifications-multi-language-support-and-more-oh-my-v2-0
properties (22)
authortimcliff
permlinkre-personz-re-timcliff-steemit-com-github-issue-guidelines-pull-request-submitted-and-approved-20170214t234006462z
categorysteemit
json_metadata{"tags":["steemit"],"links":["https://steemit.com/steemit-ideas/@timcliff/the-steemit-wish-list-avatars-notifications-multi-language-support-and-more-oh-my-v2-0"],"app":"steemit/0.1"}
created2017-02-14 23:40:06
last_update2017-02-14 23:40:06
depth2
children1
last_payout2017-03-17 02:51:45
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length344
author_reputation272,954,445,077,789
root_title"Steemit.com GitHub Issue Guidelines - Pull Request Submitted and Approved"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id2,509,452
net_rshares0
@personz · 
Wow this is really great, awesome 😁
👍  
properties (23)
authorpersonz
permlinkre-timcliff-re-personz-re-timcliff-steemit-com-github-issue-guidelines-pull-request-submitted-and-approved-20170215t005450467z
categorysteemit
json_metadata{"tags":["steemit"],"app":"steemit/0.1"}
created2017-02-15 00:54:51
last_update2017-02-15 00:54:51
depth3
children0
last_payout2017-03-17 02:51:45
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length35
author_reputation42,452,361,038,560
root_title"Steemit.com GitHub Issue Guidelines - Pull Request Submitted and Approved"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id2,509,892
net_rshares40,048,036,474
author_curate_reward""
vote details (1)
@sneak · 
We get these in the steemit/steem repo pretty regularly, too.  Editing this one down to apply to that repo would be sweet, too!
properties (22)
authorsneak
permlinkre-timcliff-steemit-com-github-issue-guidelines-pull-request-submitted-and-approved-20170217t103321968z
categorysteemit
json_metadata{"tags":["steemit"],"app":"steemit/0.1"}
created2017-02-17 10:33:00
last_update2017-02-17 10:33:00
depth1
children1
last_payout2017-03-17 02:51:45
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length127
author_reputation28,694,344,106,492
root_title"Steemit.com GitHub Issue Guidelines - Pull Request Submitted and Approved"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id2,529,336
net_rshares0
@timcliff · 
Sure, will do.
properties (22)
authortimcliff
permlinkre-sneak-re-timcliff-steemit-com-github-issue-guidelines-pull-request-submitted-and-approved-20170217t171722098z
categorysteemit
json_metadata{"tags":["steemit"],"app":"steemit/0.1"}
created2017-02-17 17:17:21
last_update2017-02-17 17:17:21
depth2
children0
last_payout2017-03-17 02:51:45
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length14
author_reputation272,954,445,077,789
root_title"Steemit.com GitHub Issue Guidelines - Pull Request Submitted and Approved"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id2,532,417
net_rshares0
@whatsup · 
The Devs need a filter between them and the end users, usually this role is filled by a support team.  I am working on some thoughts I have for a volunteer help desk.

What are your thoughts, if these ideas were flowing in a different route and filtered by type, number of cases, etc.  Would it make life easier?
👍  , ,
properties (23)
authorwhatsup
permlinkre-timcliff-steemit-com-github-issue-guidelines-pull-request-submitted-and-approved-20170214t005002944z
categorysteemit
json_metadata{"tags":["steemit"],"app":"steemit/0.1"}
created2017-02-14 00:50:03
last_update2017-02-14 00:50:03
depth1
children3
last_payout2017-03-17 02:51:45
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length312
author_reputation519,839,651,581,670
root_title"Steemit.com GitHub Issue Guidelines - Pull Request Submitted and Approved"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id2,501,127
net_rshares184,366,512,143
author_curate_reward""
vote details (3)
@timcliff · 
We are working towards making the #help channel of Steemit.chat the "go-to" place for users to get help. Right now the channel does not get much activity, but that will likely change.

There are not a _lot_ of users that are responding to people there, so often questions go unanswered for several hours. If you could help keep an eye on that channel whenever you are available, that would be a huge help!
👍  , ,
properties (23)
authortimcliff
permlinkre-whatsup-re-timcliff-steemit-com-github-issue-guidelines-pull-request-submitted-and-approved-20170214t005446033z
categorysteemit
json_metadata{"tags":["help","steemit"],"app":"steemit/0.1"}
created2017-02-14 00:54:45
last_update2017-02-14 00:54:45
depth2
children2
last_payout2017-03-17 02:51:45
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length405
author_reputation272,954,445,077,789
root_title"Steemit.com GitHub Issue Guidelines - Pull Request Submitted and Approved"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id2,501,164
net_rshares56,659,438,873
author_curate_reward""
vote details (3)
@lemouth · 
Interesting! I didn't know such a channel existed :)
👍  
properties (23)
authorlemouth
permlinkre-timcliff-re-whatsup-re-timcliff-steemit-com-github-issue-guidelines-pull-request-submitted-and-approved-20170214t025633583z
categorysteemit
json_metadata{"tags":["steemit"],"app":"steemit/0.1"}
created2017-02-14 02:56:33
last_update2017-02-14 02:56:33
depth3
children0
last_payout2017-03-17 02:51:45
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length52
author_reputation338,011,164,701,274
root_title"Steemit.com GitHub Issue Guidelines - Pull Request Submitted and Approved"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id2,501,857
net_rshares42,525,060,886
author_curate_reward""
vote details (1)
@whatsup · 
Great! Thank you.
👍  
properties (23)
authorwhatsup
permlinkre-timcliff-re-whatsup-re-timcliff-steemit-com-github-issue-guidelines-pull-request-submitted-and-approved-20170214t005733361z
categorysteemit
json_metadata{"tags":["steemit"],"app":"steemit/0.1"}
created2017-02-14 00:57:33
last_update2017-02-14 00:57:33
depth3
children0
last_payout2017-03-17 02:51:45
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length17
author_reputation519,839,651,581,670
root_title"Steemit.com GitHub Issue Guidelines - Pull Request Submitted and Approved"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id2,501,177
net_rshares42,472,010,581
author_curate_reward""
vote details (1)
Help/Feedback