Giter Club home page Giter Club logo

Comments (5)

Roshanjossey avatar Roshanjossey commented on June 18, 2024

Kudos on a well drafted issue @Trollwut. One place I've seen versions for translations is https://github.com/ContributorCovenant/contributor_covenant.

Lemme check for other resources and find an optimal way to do this

from first-contributions.

rbstrachan avatar rbstrachan commented on June 18, 2024

@Trollwut @Roshanjossey Has there been any update on this?

I believe the revision numbers could greatly help contributors that are constantly changing documents like the README.md in several languages. It would also be helpful when comparing a fork to the original.

I also agree with @Roshanjossey, the Contributor Covenant changelog has a working example of this and it doesn't seem like it would be incredilbly difficult to introduce something similar here.

There is a brilliant example of a changelog here which can be viewed in action at this repository.

If any help is needed, feel free to @-mention me.

from first-contributions.

Biograf avatar Biograf commented on June 18, 2024

@Trollwut I think having revision numbers at the (sub)-headline level would increase the risk of errors. In my experience, changing revision numbers by hand ist often a source of error. Further, the whole point of this is to learn to use the revision tool Git(hub). If you want to know what changed between two revisions, you should learn to use log and diff. If the original (English) was changed after a translation - just looking at the last date the file was changed - then the translation is not up to date. To know what has changed use log and diff. I am sorry to disagree with your proposal, but appreciate that you made it and made me think about the issue. Thank you.!

from first-contributions.

rbstrachan avatar rbstrachan commented on June 18, 2024

@Biograf Wow. Your comment just made me realise how short sighted I was being.

  • After reading your comment, I now agree with you. I don't think we should implement the revision / version numbers for exactly the reasons you pointed out.
  • I still think revision numbers are a great idea, just not for this repo. After all, its sole purpose is for beginners.

Thanks, @Biograf.

from first-contributions.

Roshanjossey avatar Roshanjossey commented on June 18, 2024

Closing this as per the consensus that emerged during the discussions

from first-contributions.

Related Issues (20)

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.