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.

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

Documentation: Import JuliaPraxis guidelines. #25204

Closed
3 tasks
Ismael-VC opened this issue Dec 20, 2017 · 0 comments
Closed
3 tasks

Documentation: Import JuliaPraxis guidelines. #25204

Ismael-VC opened this issue Dec 20, 2017 · 0 comments

Comments

@Ismael-VC
Copy link
Contributor

Ismael-VC commented Dec 20, 2017

JuliaPraxis is an organization that emerged from the need to talk about "Julia: Best Practices", there has been lots of discussions and some advances but recently it has been brought to my attention, that the current JuliaPraxis effort could be potentially ignored, because those guidelines are not part of this repository.

So I think we need to start importing those guidelines over here while discussing them in order to reach consensus on which could be considered "official" guidelines, so we can enforce them later with the aim to make the language more consistent, so others can follow the example laid out in this repository for the Julia code style and conventions.

To do:

  • Bike shed cryptic top level identifier names (starting by priority with exported ones, but also including non exported ones.)
  • Bike shed keyword argument names (:warning: breaking, would need to be done before 1.0, but we already have code freeze.)
  • Bike shed better positional argument names post 1.0

Related (mostly all the "rename x" open issues), but style also includes any kind of "refactoring tips" found in other issues, or just "best practices" in general (including for example things like documenting and coverage practices too.) Here a list of the most recent ones:

In the cases where JuliaPraxis suggestions are deemed inappropriate, such suggestions should be replaced with appropriate ones we can agree from the stylistic and naming patterns currently in use here.

So that all the issues/PRs that reflect agreement about any type of stylistic convention, should be properly documented along with the other guidelines, for the sake of consistency.

Priority would be naming style and conventions, since those are user-facing (part of APIs), and would extend to syntactic, workflow, tips, etc. type of guidelines.

@Ismael-VC Ismael-VC changed the title Import JuliaPraxis guidelines. Documentation: Import JuliaPraxis guidelines. Dec 20, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant