Giter Club home page Giter Club logo

Comments (1)

jimmo avatar jimmo commented on September 23, 2024

The list of weird and obscure "conventions"

These are pretty much the default rules enforced by black (and now ruff), and are standard to just about every Python project in existence. See https://peps.python.org/pep-0008/

impossible to manually code to

I don't agree, but also the whole point of having "opinionated" formatters like black / ruff is that you don't have to. As already pointed out in micropython/micropython#13433 you should make this run automatically (e.g. on-save hook in your editor, pre-commit for git, etc).

none of those conventions are enforced on any existing code

Would need to see an example of this, as we run the formatter over the entire repo whenever we change config or version of the formatting tool. See e.g. micropython/micropython@bbd8760 for a recent example. Possibly you're not using the right config (or the right tool?)

Pretty much everyone is going to need to run some kind of tool to make code compliant.

Exactly.

Instructions telling us how to do that are needed.

See https://github.com/micropython/micropython/blob/master/CODECONVENTIONS.md#code-auto-formatting

the discussion about "origin" and usernames and example "git remote -v" are vastly too confusing

Unfortunately these are required concepts to contribute to any GitHub project. If you want to learn more, then https://git-scm.com/book/en/v2/ is probably the best place to start, as well as GitHub's quite extensive documentation -- I can't possibly be expected to write a complete guide to git and GitHub, my goal is just to provide a few recipes for the things that people are likely to encounter with our project (although many other projects use a nearly-identical workflow).

we need to be reading step-by-step things

People are welcome to submit PRs with improvements, but unfortunately unless I understand what the issues and conceptual hurdles people are running into it's very difficult to just intuit what exactly you need me to explain. As per
https://github.com/jimmo/git-and-micropython#contributing if the advice here isn't working then please provide information about what you tried, what output you got, etc.

(Just a reminder, this is something I wrote in my spare time)

from git-and-micropython.

Related Issues (2)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.