Slashdot Mirror


GitHub Invites Contributions To 'Open Source Guides' (infoq.com)

An anonymous reader quotes InfoQ: GitHub has recently launched its Open Source Guides, a collection of resources addressing the most common scenarios and best practices for both contributors and maintainers of open source projects. The guides themselves are open source and GitHub is actively inviting developers to participate and share their stories... "Open source is complicated, especially for newcomers. Experienced contributors have learned many lessons about the best way to use, contribute to, and produce open source software. Everyone shouldn't have to learn those lessons the hard way."

Making a successful first contribution is not the exclusive focus of the guides, though, which also strives to make it easier to find users for a project, starting a new project, and building healthy open source communities. Other topics the guides dwell on are best practices, getting financial support, metrics, and legal matters.

GitHub's Head of Open Source says the guides create "the equivalent of a water cooler for the community."

54 comments

  1. I hate u by Anonymous Coward · · Score: 0

    nt

  2. Open Spruce is Eazy by Anonymous Coward · · Score: 0

    Secret to successfull coder carreerr!

    How to git your pull requests accepted on GitHub, in two eazy steps:

    {1} Be a Rockstar.
    {2} Don't not be a Rockstar.

    1. Re:Open Spruce is Eazy by Aighearach · · Score: 1

      And if you don't want to be a rockstar, instead of trying to offer patches just post insulting bug reports and call the developers names.

    2. Re:Open Spruce is Eazy by Anonymous Coward · · Score: 1

      "Hey guys I noticed your code was doing some strange things under the following circumstances and it was really bothering me so I spent two weeks of my spare time tracking down the bug and I finally found it and I wrote a patch to fix it and I tested the patch for another two weeks and I am completely sure the patch is correct and it works for me so I think other people would find it helpful if you could please accept my patch."

      One month later, "Hello? I fixed a bug."

      Two months later, "Guys? Did you try my patch?"

      Three months later, "What the hell guys, did you even look at it?"

      Four months later, "Come on guys, there's a bug! And I patched it for you!"

      Five months later, "What the shit!! You're accepting other patches but not mine!!! What's wrong with it? Did you even test it at all?"

      Six months later, "FUCK YOU GUYS! FUCK YOUR FUCKING PROJECT! FUCK OPEN SOURCE!!! I'M NEVER CONTRIBUTING AGAIN!!!! BECAUSE YOU'RE ALL MOTHERFUCKERS!!!!!!"

    3. Re:Open Spruce is Eazy by Anonymous Coward · · Score: 0

      Another troll is banned to the abyss, and as the brogrammers snort coke off a hookers ass, they wonder why more rockstars don't contribute to their elite project.

    4. Re:Open Spruce is Eazy by fisted · · Score: 0

      Instead of getting mad, just maintain the patch locally. You have fixed the bug for you, after all, so why get angry. The only thing that does suck is if you later find out your patch has been merged, but without attribution, in which case a passive aggressive mail to their list might be in order. Happens rarely, though.

      And there are more than enough counter examples to your story, e.g. my latest fix to icinga (a nagios fork) had a turnaround time of roughly half an hour (Though github will only show it happened on the same day...)

    5. Re:Open Spruce is Eazy by Anonymous Coward · · Score: 0

      You miss the point. The patch is maintained locally, because the aspiring contributor finds it useful. According to the story, the patch was available to the public for six months. The story does not say whether the patch was deleted after six months, although sometimes that does happen.

      The point is the aspiring contributor became discouraged, lost faith in open source, and stopped contributing forever.

      The problem is all further patches by that discouraged contributor will never be published, anywhere, ever. The open source movement lost potential talent. You cannot point to examples of lost talent because they returned to obscurity after enduring the rockstar shitshow that is github.

  3. step one had better say.. by Anonymous Coward · · Score: 0
  4. Not foolproof by lucm · · Score: 1

    So they need Open Source Guides to explain how to get involved in Open Source, and yet they want people to jump into writing those Open Source Open Source Guides without any kind of introduction to Open Source?

    If they really want to get this "Open Source water cooler" going, someone should get started on Open Source Open Source Open Source Guides to writing Open Source Open Source Guides about Open Source.

    --
    lucm, indeed.
    1. Re:Not foolproof by FatdogHaiku · · Score: 1

      Never send a water cooler to do the job of an open bar...
      of course, with an open bar you get unintelligible documentation and comments like "oh swet" and "you se what I di thre?"

      --
      You have the right to remain sentient. If you give up the right to remain sentient, you will be elected to public office
    2. Re:Not foolproof by Dutch+Gun · · Score: 4, Insightful

      I see they're recommending a "Code of Conduct" for open source projects. How else could we possibly get along with one another if all the rules of behavior aren't spelled out in the most minute details. Generally speaking, all of those boil down to "Be civil" anyhow, just expressed in a few thousand more words.

      Is it really not adequate these days for a project or community to just tell everyone to "be civil", to enforce that civility with common sense, and leave it at that?

      --
      Irony: Agile development has too much intertia to be abandoned now.
    3. Re:Not foolproof by lucm · · Score: 1

      One of the best programmers I know was also a drunk, and without even looking at the commit time I could tell by his code whether he wrote it before or after lunch (when he would down a few pints of beer daily).

      I say "was" because he's no longer a good programmer. The booze won.

      --
      lucm, indeed.
    4. Re:Not foolproof by Anonymous Coward · · Score: 0

      Fell off Ballmer's Peak, did he?

    5. Re:Not foolproof by AmiMoJo · · Score: 2

      People will disagree about what "be civil" and "common sense" mean. Writing some rules down helps enumerate the worst stuff and set the tone, but even then there will be complaints and conspiracy theories when they are enforced.

      I'll give you an example. A guy writes that the can't do the merge this weekend because he is going on a trip with his husband. Someone else complains about having same sex marriage rammed down their throat and claims that common sense requires such couples to hide their "controversial" relationships. In such a case, a written statement of principals really helps.

      --
      const int one = 65536; (Silvermoon, Texture.cs)
      SJW, n: "Someone I don't like, and by the way I'm a fuckwit" - AC
    6. Re:Not foolproof by Anonymous Coward · · Score: 0

      Avoiding controversy was easier when nerds worked with other nerds, before the normals invaded and brought their prejudices with them. I remember back in the 1990s, I met a female coworker who casually mentioned she was dating a woman. I just thought, "OK. I guess she's gay," and it was a complete nonissue. We had more controversy over musical preferences than sexual orientation; she thought she could annoy me by playing Starship, but she didn't know I'm a fan of Mannequin, so she had to find another band to assault my ears. And as fellow nerds, we bonded over BSD.

    7. Re:Not foolproof by NotInHere · · Score: 3, Informative

      Just note that in this context, "Code of Conduct" has a different meaning that extends beyond the legitimate rule to be civil. Its one of those SJW phrases that they took hold of and completely skewed in meaning (like "enabler" or "diversity" -- for them, everything SJW is "diverse" but everything even slightly critical of SJW is "bigoted", funny how they turn the terms around by 180 degrees). Their goal is to make you believe that an environment that is toxic towards people who think different from the (SJW) mainstream is just "enforcing good behaviour". Remember, github is the company that threatened to ban an open source project for (humorously) using the word "retard" in its advertisement (just google "github retard" to find out what I mean), and whose "VP of social impact" repeatedly made racist statements: http://www.businessinsider.com... ... probably they think that when its anti white its not racist.

    8. Re:Not foolproof by Anonymous Coward · · Score: 0

      People often tend to think common sense is common, however for any slice of "common sense" that's only true for a locality or monoculture. These projects are becoming more global and comprised of individuals from many various cultures and backgrounds, and they often have quite different interpretations of various social cues as well as values and morals. The code of conducts are often necessary.

      As an example, there are many cultures remaining in the world where men will simply refuse to work with or for women. Think that's shocking? There are still cultures remaining in the world where a man can have his wife stoned to death by a random mob simply because she displeased him. You may think that's disgusting; that entire society thinks it's just the way of life. In online exchanges, such behavior can easily come across in a variety of negative forms. If you don't attempt to lay down some ground rules, any attempts to reign in or retaliate against that kind of behavior can also have extremely negative impacts on the community or project.

    9. Re:Not foolproof by Anonymous Coward · · Score: 0

      People will disagree about what "be civil" and "common sense" mean. Writing some rules down helps enumerate the worst stuff and set the tone, but even then there will be complaints and conspiracy theories when they are enforced.

      I'll give you an example. A guy writes that the can't do the merge this weekend because he is going on a trip with his husband. Someone else complains about having same sex marriage rammed down their throat and claims that common sense requires such couples to hide their "controversial" relationships. In such a case, a written statement of principals really helps.

      Right, one of the most common clauses in codes of conduct bans "the use of sexualized language or imagery" which this could easily be seen to fall foul of. It's a real case where the wrong code of conduct could easily be seen as a form of illegal discrimination. It's just not appropriate and acceptable to be regulating other people's private sexuality even even if it has some form of public expression.

    10. Re:Not foolproof by Dutch+Gun · · Score: 1

      I'm not asking people to agree on every contentious issue. Yes, there will be some variance on what "be civil" means, but working in a group also requires a bit of tolerance. That's part of peacefully coexisting in a diverse workforce. No, I'm not talking about tolerating blatantly racist or sexist behavior, but recognizing that, so long as there is no ill intent, we should be willing to forgive minor trespasses or foibles.

      My concern with creating a list of all principles, rules, prohibitions, etc, is that it appeals to rules lawyers, and no one else. I'm pretty sure Uber has a big list of these rules and prohibitions, but look at what that place is (allegedly) like, especially for female engineers. In short, it feels a bit to me like a feel-good measure that doesn't actually prevent bullying and backstabbing, and in some cases, even provides the tools for doing so.

      I don't actually oppose codes of conduct per se, despite my Devil's advocate position. I just think recently that they've taken on a life of their own, and have gotten too complicated or convoluted, and in the process undermines their purpose. You've probably heard of this line in the Open Code of Conduct:

      Our open source community prioritizes marginalized people’s safety over privileged people’s comfort.

      I think it's inappropriate for a code of people to define and divide people into "marginalized people" and "privileged people". Are people surprised then, when the Code of Conduct itself becomes controversial? This line is, by its own admission, quite divisive.

      Ubuntu's, on the other hand, reads like this:

      Be considerate

      Our work will be used by other people, and we in turn will depend on the work of others. Any decision we take will affect users and colleagues, and we should consider them when making decisions.

      Be respectful

      Disagreement is no excuse for poor manners. We work together to resolve conflict, assume good intentions and do our best to act in an empathic fashion. We don't allow frustration to turn into a personal attack. A community where people feel uncomfortable or threatened is not a productive one.

      Take responsibility for our words and our actions

      We can all make mistakes; when we do, we take responsibility for them. If someone has been harmed or offended, we listen carefully and respectfully, and work to right the wrong.

      And then goes on for a few thousand more words... But one thing I appreciate is they try to offer advice on how to achieve technical excellence as well as inter-group harmony, which I think makes sense for an open-source project.

      If you feel you must have a Code of Conduct, it seems better to affirm the positive attributes to which community members should strive, rather than listing all the ways one person can be horrible to another person, like the Open Code of Conduct, which defines "harassment" with a litany of examples.

      --
      Irony: Agile development has too much intertia to be abandoned now.
    11. Re:Not foolproof by Dutch+Gun · · Score: 1

      Note: to clarify, the Open Code of Contact has very similar positive statements as Ubuntu's. I just feel all the negative examples and definition (which Ubuntu omits) are, if you'll pardon the pun, not a positive thing.

      --
      Irony: Agile development has too much intertia to be abandoned now.
    12. Re:Not foolproof by Anonymous Coward · · Score: 0

      Is it really not adequate these days for a project or community to just tell everyone to "be civil", to enforce that civility with common sense, and leave it at that?

      No, you need to:

      1. hire the most outrageously racist and sexist bigots you can find to lecture you about your white male privilege
      2. put them in charge of HR
      3. look the other way as the new people they hire start fights with your old employees
      4. look the other way as your new employees share all of your trade secrets with their awesome IRC friends from China and Pakistan
      5. fire anybody who says this is stupid and make sure the other nearby tech companies know to blacklist them
      6. enjoy the great PR you will get from all of the tech publications for your commitment to diversity
      7. sell your bankrupt company at 5% of its peak value to the angel investor who trained and organized the people in step 1
  5. I hope they focus on the command line by Anonymous Coward · · Score: 0

    I'll have to check these out. I'm hoping there are some with a focus on command line usage of git with GitHub. In the past, a lot of their tutorials took an almost hostile attitude about the shell. You don't have to use any gross complicated command lines like a geeky nerd! Just clicky-click in 20 places to do Step 1 of the tutorial... Their guides were either trying to bunny-coddle you through doing everything on the web interface, or get you to install their desktop client (no thank you, I have a terminal). I had to go find external documentation to learn how to use their site properly.

    1. Re:I hope they focus on the command line by Anonymous Coward · · Score: 0

      You don't get paid the big buck bunny money for command line skills. Command line skills are for the basement dwellers living in poverty who code original software which they give away for free. You get paid to fork them over when you innovate your wrapper app around preexisting code made by some loser and market your innovative app to idiots.

    2. Re:I hope they focus on the command line by Anonymous Coward · · Score: 0

      Apps app apps, not LUDDITE command lines!

    3. Re:I hope they focus on the command line by Foofoobar · · Score: 1

      I HACKZORZ ur APPS W1T my luddite shell

      --
      This is my sig. There are many like it but this one is mine.
  6. Yes foolproof by Anonymous Coward · · Score: 0

    Rockstar

    Rockstar is one amazing library, which will make you a Rockstar Programmer in just 2 minutes. In last decade, people learned C++ in 21 days. But these days, it has come down to just 10 minutes. But, I wanted to do better.

    This repo will not only teach you Complete C++ in just 2 minutes, but also makes Open Source Contributions. You see, Open Source contributions are very important these days, especially if you can get those boxes filled with green on your Github profile. As an efficient programmer, I believe in killing two birds in just one shot.

    Run Rockstar, be a Rockstar, show off your Github profile to everyone and bag those $200K programmer jobs. Once you become a Rockstar, every recruiter will want to hire you and there is no turning back.

  7. I love NT by Anonymous Coward · · Score: 0

    MS forever!

  8. Don't show this to the Linus/Linux Kernel Group by Proudrooster · · Score: 0

    Make people feel welcome!

    A welcoming community is an investment into your project’s future and reputation. If your project is just starting to see its first contributions, start by giving early contributors a positive experience, and make it easy for them to keep coming back.

    or

    Call your contributors Brain-damaged sh*t-for-brains' devs tell them to drop 'drug-induced crap' and use asterisks properly.

    Whatever works! :)

    1. Re:Don't show this to the Linus/Linux Kernel Group by Anonymous Coward · · Score: 0

      The knuckles are what keep those wannabes, SJWs and trolls out.

    2. Re:Don't show this to the Linus/Linux Kernel Group by Anonymous Coward · · Score: 3, Funny

      actually, it's about enforcing SJW safe spaces into everyone's projects. they hate meritocracy and they seriously said that pull requests from minorities & women should have higher priority over stuff from straight white males.

    3. Re:Don't show this to the Linus/Linux Kernel Group by Anonymous Coward · · Score: 0

      The third option. Ignore your contributors. Don't acknowledge them in any way. Make them unwelcome. Ignore them until they stop trying to contribute. Eventually they go away.

    4. Re:Don't show this to the Linus/Linux Kernel Group by Anonymous Coward · · Score: 0

      yeah I bet you, personally are a big contributor to top open source projects
      lol

    5. Re:Don't show this to the Linus/Linux Kernel Group by lucasnate1 · · Score: 1

      Do you have any reference for this claim? (I'm not asking to prove you wrong, I'm asking because I am afraid you are saying the truth)

    6. Re:Don't show this to the Linus/Linux Kernel Group by Anonymous Coward · · Score: 0

      You need to read further into the code of conduct these jackholes are pushing. They basically say that merit means nothing and if you say or do anything that hurts someone's feels, you're out of there. They're shoving out the people who do work and replacing them with their own pod-people of lesser talented twits who "think the right way".

    7. Re:Don't show this to the Linus/Linux Kernel Group by Proudrooster · · Score: 1

      SJW (Learning a new meme SJW) https://www.youtube.com/watch?...

    8. Re:Don't show this to the Linus/Linux Kernel Group by serviscope_minor · · Score: 1

      Whatever works! :)

      It works sufficiently for Linux, but the fact it works at all does not imply that something else couldn't work better. Several high profile kernel devs have left due to the flood of shite. Matthew Garrett is one and he was responsible for a huge amonut of the power saving code which makes Linux actually acceptable on laptops.

      --
      SJW n. One who posts facts.
    9. Re:Don't show this to the Linus/Linux Kernel Group by Anonymous Coward · · Score: 0

      The key document you are looking for is "The Dehumanizing Myth of the Meritocracy. If you look for places that it is referenced from the you will find quite a number of examples where a specific argument is being made against the assessing a developer based on meritocratic methods.

      N.B. I am not the original AC who you asked about this.

  9. a Code of Conduct is a weapon by lucm · · Score: 1

    i think the point of a Code of Conduct is to have a baseline to kick someone out if they're being undesirable. It's similar to having an acceptable internet usage policy at work; the point is not to prevent people from checking Facebook during work hours, it's to give yourself some ammo in case you want to get rid of someone for some other reason. (ex: "On July 6, you broke rule 212.1 by visiting Reddit during work hours, so you're fired - although what we really don't like about you is that you f*cked the CEO's daughter and wiped yourself on his MBA diploma").

    That's how they got Martha Stewart, by the way. She didn't go to jail for insider trading, she went to jail for lying to federal officers who were investigating her insider trading activities.

    --
    lucm, indeed.
    1. Re:a Code of Conduct is a weapon by Anonymous Coward · · Score: 0

      If you fire me, I'm going to rape your daughter and kill your dog.

    2. Re:a Code of Conduct is a weapon by Anonymous Coward · · Score: 0

      So essentially it's the seed of an HR department.. great.
      HR departments do not exist to protect the employees, they exist to cover the ass of those above who run the show: to get rid of problems before they become, well, a problem.

      If an OSS project has become this scared that it needs HR tactics, then it's poisoned and needs forking.

    3. Re:a Code of Conduct is a weapon by Anonymous Coward · · Score: 0

      Open source has gone corporate to make billions for the tech industry. This is not news.

    4. Re:a Code of Conduct is a weapon by Dutch+Gun · · Score: 1

      I understand the necessity of a Code of Conduct for a business that hires employees. Because federal laws, and lawsuits, and all that other fun stuff.

      I don't understand why a programming language, as a recent example, requires a Code of Conduct. If you want your official forums to be civil, than enforce civility. Why on earth would you write up a multi-page document explicitly listing every little prohibition and affirmation, unless it's just for virtue signalling?

      --
      Irony: Agile development has too much intertia to be abandoned now.
    5. Re:a Code of Conduct is a weapon by serviscope_minor · · Score: 1, Insightful

      I don't understand why a programming language, as a recent example, requires a Code of Conduct.

      A programming language doesn't: such a thing is nonsensical because a language is inanimate and has no agency. The people in the community who contribute, however, do. If you can't see why people need a code of conduct then I can only ask: have you ever met people?

      If you want your official forums to be civil, than enforce civility.

      Using your personal, unwritten code of civility, I assume, even though it differs from mine?

      --
      SJW n. One who posts facts.
    6. Re:a Code of Conduct is a weapon by Anonymous Coward · · Score: 1

      Using your personal, unwritten code of civility, I assume, even though it differs from mine?

      And this is the killer. If you read many projects codes of conduct are very specific about the classes of discrimination they disallow. Discrimination or attacks on people based on organisational membership or political beliefs, for example, will be allowed. Often this is just due to doing a copy paste of one of the standard CoCs. In some organisations and in some of the very important original CoCs everyone copies, however, it's deliberate because the authors of the CoC want to reserve the right to be "uncivil" to people who have specific views even if they are not expressing those views, let alone attacking anyone over them.

      Another dangerous thing is that some codes of conduct may impose a duty of enforcement on the project maintainers even if they themselves believe that it is not appropriate in a given case. Again, normal civil society requires people to be forgiving of mistakes, but some people and some codes of conduct work against this. Even if you just said "be civil or you will be banned", a non English speaker may end up banned over a language misunderstanding.

      In a big project that doesn't have a code of conduct you will almost certainly come across a situation soon which will force you to have one. This means that it's worth having a code of conduct but being very careful to ensure that the code of conduct does not make things worse. Do not privilege special classes of people of any kind with protection whilst discriminating against others. Do not allow the code of conduct to force people to do enforcement when they don't think it's the right thing to do. Make sure that the code of conduct is simple and doesn't give opportunity for endless net-lawyering and trolling. Do not allow public punishment and damage to contributors without due process.

  10. Re:TRUMP calls GitHub FAKE Site! by Anonymous Coward · · Score: 0

    Trump was disappointed to learn the octocat doesn't have octopussy.

  11. Tutorial - text, all in one file by Anonymous Coward · · Score: 0

    I can only speak for myself, but my strong personal preference for tutorials is text (not video), all on one file. (Either a web page, or a pdf file.) Give me step 1 instructions, images and sample code at the top of the file. Then below that, step 2 instructions, images and sample code, etc.

    With a text-based tutorial, I don't have to take notes from what someone is saying in a video. And it's easier to save a tutorial that's all in one file, unlike GitHub's tutorial.

  12. Github by Anonymous Coward · · Score: 0

    Isn't GitHub a SJW cesspool ?

    1. Re:Github by Anonymous Coward · · Score: 0

      Github is the facebook of social coding.

  13. Opinions are routable. by Anonymous Coward · · Score: 0

    If you hit a 'circle jerk' open source project... fork! Opinions are routable. My 2c.

    1. Re:Opinions are routable. by Anonymous Coward · · Score: 1

      The trouble with forking at the first sign of trouble is too many forks end up having exactly one user. Nobody collaborates to squash bugs, fix security flaws, add features, or test anything. The resulting plethora of forks becomes unusable by anyone who doesn't want to research every branch of every fork and cherry pick commits.

    2. Re:Opinions are routable. by Anonymous Coward · · Score: 0

      That is true but if the fork has technical merit by solving problems for a majority of users that the 'circle jerk' project refuse to implement the fork will survive or be absorbed back into the main project. There is nothing wrong with forking. In fact it is healthy IMHO, let the code stand or fall on its own usefulness. If you solve a problem for a bunch of people and put it out there, a bunch of people will come. If the people do not come to your fork all you have is a publically made hack that solves your problem. Either way it is a win-win. It just means someone went down a path that hadn't been tried before. That is exciting.

  14. Fuck GitHub by Anonymous Coward · · Score: 3, Funny

    No. Fuck GitHub. I refuse to use or support a company that is all about censorship and shutting down "wrongthing" because someone has a different viewpoint than they do. GitHub is a festering pile of shit. Use alternatives.

    1. Re: Fuck GitHub by Anonymous Coward · · Score: 0

      GitHub is racist and sexist. Best to avoid it.