Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Proposal to develop official "Developers' Guidelines" #331

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.

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

Closed
flimzy opened this issue Oct 18, 2015 · 5 comments
Closed

Proposal to develop official "Developers' Guidelines" #331

flimzy opened this issue Oct 18, 2015 · 5 comments
Labels

Comments

@flimzy
Copy link
Member

flimzy commented Oct 18, 2015

I'd like to suggest that it might be worth while to begin formulating a sort of Developers' Guidelines document somewhere, which documents official and semi-official guidelines, preferences, and expectations of new developers contributing to GopherJS directly, and perhaps those writing modules for use by the GopherJS community.

As a recent sample of two items that might fit in such a document:

Also (added by @shurcooL):

I realize there are likely very few "official" decisions to document right now, but I expect that will change (and is changing!).

Currently, we have just the issue tracker, but something more digested for newcomers I think would be appropriate.

Would this be welcomed? And if so, where should it live? Some obvious (to me) options:

  • DEVELOPERS.md in the main repo
@traveller42
Copy link

I feel some kind of Developers' Guide is useful. Location is less important than ensuring it is easy to find.

It should include information on how to find previous discussion on an issue. One doesn't want to spend time on something that the wider community has either rejected or deferred for reasons that may not be obvious to the newcomer.

A style guide is important in keeping the look of the code consistent. I will submit that once such is in place, the existing code will need to be reviewed to provide a good example for comparison.

I think the links to the earlier items as above are good and should be encouraged.

@dmitshur
Copy link
Member

I agree, this would be useful to as a place to collect and post this information, that is currently mostly scattered throughout closed and open issues.

I think the Wiki is a good place to put this.

We can start by adding Richard's comment, and the other issues you've linked.

@flimzy
Copy link
Member Author

flimzy commented Oct 19, 2015

I put some (very minimal) information on the wiki to get this project started: https://github.com/gopherjs/gopherjs/wiki/Developer-Guidelines

If we're happy with this, we can probably close this issue, and just start keeping that page up to date.

@dmitshur
Copy link
Member

That looks like a great start, thanks for doing it!

@dmitshur
Copy link
Member

dmitshur commented Feb 8, 2016

If we're happy with this, we can probably close this issue, and just start keeping that page up to date.

Let's do that. It'll help keep the open issue count lower, down to just actionable ones.

I think that page looks great and it's useful. Thanks again for doing this!

@dmitshur dmitshur closed this as completed Feb 8, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants