Contributor Guidelines

C programming, build, interpreter/VM.
Target audience: MicroPython Developers.
pfalcon
Posts: 893
Joined: Fri Feb 28, 2014 2:05 pm

Contributor Guidelines

Postby pfalcon » Sat Jan 31, 2015 3:05 pm

MicroPython project is steadily growing, with more and more people contributing to its developments in various areas. To foster this activity and make both contributors' and maintainers' effort easier, while preserving overall direction and distinctive features of the project, there're now Contributor Guidelines available at https://github.com/micropython/micropyt ... Guidelines .

All people interested in contributing to MicroPython are welcome and encouraged to review the guidelines.

The guidelines are work in progress and subject for community discussion. Please feel free to share you comments and suggestion here, or in the ticket: https://github.com/micropython/micropython/issues/1007

pfalcon
Posts: 893
Joined: Fri Feb 28, 2014 2:05 pm

Re: Contributor Guidelines

Postby pfalcon » Mon May 04, 2015 10:43 am

Link to the guidelines is now shown to everyone submitting new issues or pull request, e.g.: https://github.com/micropython/micropython/issues/new

User avatar
pythoncoder
Posts: 1393
Joined: Fri Jul 18, 2014 8:01 am

Re: Contributor Guidelines

Postby pythoncoder » Tue May 05, 2015 11:56 am

@pfalcon Shouldn't the link in your above message be https://github.com/micropython/micropython/blob/master/CONTRIBUTING.md?
Peter Hinch

User avatar
pythoncoder
Posts: 1393
Joined: Fri Jul 18, 2014 8:01 am

Re: Contributor Guidelines

Postby pythoncoder » Tue May 05, 2015 12:10 pm

A general comment on the guidelines: should there be a reference to this document https://github.com/micropython/micropython/wiki/DevelWorkflow?

A factor to bear in mind is the target audience. Clearly the guidelines are written for experienced programmers, who can be assumed to be able to follow fairly terse instructions and to access links. But some may be unfamiliar with contributing to open source projects and with Git and Github. The learning curve for Git, even for those who've used other VCS's, is steep and some pointers to external tutorials might be helpful. I'm finding https://progit.org/ useful but you guys may have other, better, suggestions.
Peter Hinch

pfalcon
Posts: 893
Joined: Fri Feb 28, 2014 2:05 pm

Re: Contributor Guidelines

Postby pfalcon » Tue May 05, 2015 1:10 pm

pythoncoder wrote:@pfalcon Shouldn't the link in your above message be https://github.com/micropython/micropython/blob/master/CONTRIBUTING.md?


Well, I wanted to show people how submitting a new ticket shows them a hard-to-miss (hopefully? ;-) ) yellow box which links to the guidelines.

pfalcon
Posts: 893
Joined: Fri Feb 28, 2014 2:05 pm

Re: Contributor Guidelines

Postby pfalcon » Tue May 05, 2015 1:21 pm

pythoncoder wrote:A general comment on the guidelines: should there be a reference to this document https://github.com/micropython/micropython/wiki/DevelWorkflow?

A factor to bear in mind is the target audience. Clearly the guidelines are written for experienced programmers, who can be assumed to be able to follow fairly terse instructions and to access links.


That's exactly the reason why DevelWorkflow isn't "PRed" much - I know that stuff too well, so just dumped my mind to give hints to people how they can have better workflow (than have random stuff included in their pull requests or have back-and-forth changes). It's expected that people would do some googling, then hopefully someone brave will add more links to that page (or suggest better written page right away - there gotta be such).

But some may be unfamiliar with contributing to open source projects and with Git and Github. The learning curve for Git, even for those who've used other VCS's, is steep and some pointers to external tutorials might be helpful. I'm finding https://progit.org/ useful but you guys may have other, better, suggestions.


The general idea behind specifically ContributorGuidelines is to minimize probability that someone wants to contribute, spends time to develop code, submits it and gets a reply "sorry, we don't need it/you did it wrong". I know such situation sucks - I don't contribute to some useful/important projects because my initial attempts led to such situation. So, I'd like to do everything possible to avoid such situation, while still make sure that we don't deteriorate the project into yet another scopeless monster like some open-source projects are.

The guidelines do need improvements, that's why this topic was opened and why the wiki page was linked just from this topic for quite a while, to let everyone express concerns/propose improvements. With more people contributing, it's important to make it more visible, but elaboration process is continuous, and all comments are welcome (and actual improvements too).


Return to “Development of MicroPython”

Who is online

Users browsing this forum: No registered users and 1 guest