Jorge O. Castro
    • Create new note
    • Create a note from template
      • Sharing URL Link copied
      • /edit
      • View mode
        • Edit mode
        • View mode
        • Book mode
        • Slide mode
        Edit mode View mode Book mode Slide mode
      • Customize slides
      • Note Permission
      • Read
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Write
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Engagement control Commenting, Suggest edit, Emoji Reply
    • Invite by email
      Invitee

      This note has no invitees

    • Publish Note

      Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note

      Your note will be visible on your profile and discoverable by anyone.
      Your note is now live.
      This note is visible on your profile and discoverable online.
      Everyone on the web can find and read all notes of this public team.
      See published notes
      Unpublish note
      Please check the box to agree to the Community Guidelines.
      View profile
    • Commenting
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
      • Everyone
    • Suggest edit
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
    • Emoji Reply
    • Enable
    • Versions and GitHub Sync
    • Note settings
    • Note Insights
    • Engagement control
    • Transfer ownership
    • Delete this note
    • Save as template
    • Insert from template
    • Import from
      • Dropbox
      • Google Drive
      • Gist
      • Clipboard
    • Export to
      • Dropbox
      • Google Drive
      • Gist
    • Download
      • Markdown
      • HTML
      • Raw HTML
Menu Note settings Versions and GitHub Sync Note Insights Sharing URL Create Help
Create Create new note Create a note from template
Menu
Options
Engagement control Transfer ownership Delete this note
Import from
Dropbox Google Drive Gist Clipboard
Export to
Dropbox Google Drive Gist
Download
Markdown HTML Raw HTML
Back
Sharing URL Link copied
/edit
View mode
  • Edit mode
  • View mode
  • Book mode
  • Slide mode
Edit mode View mode Book mode Slide mode
Customize slides
Note Permission
Read
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
Write
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
Engagement control Commenting, Suggest edit, Emoji Reply
  • Invite by email
    Invitee

    This note has no invitees

  • Publish Note

    Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note

    Your note will be visible on your profile and discoverable by anyone.
    Your note is now live.
    This note is visible on your profile and discoverable online.
    Everyone on the web can find and read all notes of this public team.
    See published notes
    Unpublish note
    Please check the box to agree to the Community Guidelines.
    View profile
    Engagement control
    Commenting
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    • Everyone
    Suggest edit
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    Emoji Reply
    Enable
    Import from Dropbox Google Drive Gist Clipboard
       owned this note    owned this note      
    Published Linked with GitHub
    Subscribed
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    Subscribe
    One of the neat things about Open Source is all the things you get to learn about teamwork and coordinating with others. This can lead to great things, but sometimes it's so easy to start off excited, and then pick a project and drown immediately. Bob Killen [recently distilled his contributor lessons](https://twitter.com/MrBobbyTables/status/1678823563527090185) over years of contributing to Kubernetes and other Cloud Native projects. Consider this the blog version: # Research First The best tip we can recommend is to educate yourself about the project, its community and their contributor processes BEFORE asking questions. Look for a CONTRIBUTING.md file in the repository and start from there. People are much more willing to help you if you ask "Hey, I noticed this issue is still open. I’m interested in working on it, but couldn’t find info on <foo>, is there a good reference or person I can talk to about it?" vs "Hey, I’m new to <project> and want to contribute, where do I start"? Starting with `good-first-issue` labelled issues never hurts, and you can use tools like [CLOtributor](https://clotributor.dev) to aggregate good first issues across projects, so if you fancy a certain language or tech stack you can start from a knowledgeable place. # Give it a hot minute If you open a PR, give it a little time before asking for reviews. OSS is a global phenomenon that spans all time zones. It involves people that do it as a hobby on weekends, or others may do it as part of their $dayjob, but also have to balance it with their other projects. That doesn't mean you need to wait forever before reaching out, but don’t go repeatedly asking for reviews right after opening your pull request. It may take a few days for the person to get to it. If it has been a bit, its okay to give it a nudge. Everyone is drowning in GitHub notifications, so don't be afraid to point out where you need a review, but just be cognizant of the load and be mindful of the existing open requests. # Start with contributions you KNOW you can do. Learning and growth are wonderful parts of Open Source, but when starting out, take on something in an area where you can flex your experience. We can’t tell you how many people have reached out to maintainers asking to get involved in the most complex and difficult parts of the project without understanding the fundamentals. This leads to a lot of frustration both from the contributor and the maintainers. Remember, the maintainers who work in those areas have likely been contributing for years. They didn’t just jump into it either. # Trivial pursuits are not fun Reviewing pull requests can take time. This usually involves running a bunch of automated test suites, then it can take a human a non-trivial amount of time to review a submission. Make it count! - Tired: Sending a pull request to an entire team to fix one misspelled word in the docs - Wired: Spending a bit more time thinking about how best to improve multiple parts of the page # Don’t over commit. Related to the last one, but start small and with things you know you can do in a reasonable time frame. It is common for new contributors to get excited and volunteer or self assign every new issue coming in, and in the end they can’t deliver on most of them. This frustrates them, the maintainers and the other potential new contributors getting started. # Learn the git basics You should be familiar with general pull request based workflow, branching, squashing and rebasing. You don’t have to be able to do them without looking up a reference, but know what they are and when they should be used. Certain projects [document their workflow](https://www.kubernetes.dev/docs/guide/github-workflow/) so that project conventions can be shared. There are plenty of people who contribute non-code contributions and others that can get by without learning git, but you will have a MUCH better experience if you’re familiar with it and can have a basic working set of skills. Don't worry, git itself ensures that you will never truly understand it, so don't beat yourself up over it. # Be intentional Many of these tips boil down to one thing: if you want to contribute to a project, to become a maintainer, then be intentional. Learn what you can beforehand, be willing to continue to learn, and get engaged in the right places. Maintainers will SERIOUSLY bend over backward to help or mentor those demonstrating that commitment, who will stick around, and who can be grown into future maintainers. It's how the projects keep themselves going. Technical skills like git, CI/CD, and review workflow come with time and practice.

    Import from clipboard

    Paste your markdown or webpage here...

    Advanced permission required

    Your current role can only read. Ask the system administrator to acquire write and comment permission.

    This team is disabled

    Sorry, this team is disabled. You can't edit this note.

    This note is locked

    Sorry, only owner can edit this note.

    Reach the limit

    Sorry, you've reached the max length this note can be.
    Please reduce the content or divide it to more notes, thank you!

    Import from Gist

    Import from Snippet

    or

    Export to Snippet

    Are you sure?

    Do you really want to delete this note?
    All users will lose their connection.

    Create a note from template

    Create a note from template

    Oops...
    This template has been removed or transferred.
    Upgrade
    All
    • All
    • Team
    No template.

    Create a template

    Upgrade

    Delete template

    Do you really want to delete this template?
    Turn this template into a regular note and keep its content, versions, and comments.

    This page need refresh

    You have an incompatible client version.
    Refresh to update.
    New version available!
    See releases notes here
    Refresh to enjoy new features.
    Your user state has changed.
    Refresh to load new user state.

    Sign in

    Forgot password

    or

    By clicking below, you agree to our terms of service.

    Sign in via Facebook Sign in via Twitter Sign in via GitHub Sign in via Dropbox Sign in with Wallet
    Wallet ( )
    Connect another wallet

    New to HackMD? Sign up

    Help

    • English
    • 中文
    • Français
    • Deutsch
    • 日本語
    • Español
    • Català
    • Ελληνικά
    • Português
    • italiano
    • Türkçe
    • Русский
    • Nederlands
    • hrvatski jezik
    • język polski
    • Українська
    • हिन्दी
    • svenska
    • Esperanto
    • dansk

    Documents

    Help & Tutorial

    How to use Book mode

    Slide Example

    API Docs

    Edit in VSCode

    Install browser extension

    Contacts

    Feedback

    Discord

    Send us email

    Resources

    Releases

    Pricing

    Blog

    Policy

    Terms

    Privacy

    Cheatsheet

    Syntax Example Reference
    # Header Header 基本排版
    - Unordered List
    • Unordered List
    1. Ordered List
    1. Ordered List
    - [ ] Todo List
    • Todo List
    > Blockquote
    Blockquote
    **Bold font** Bold font
    *Italics font* Italics font
    ~~Strikethrough~~ Strikethrough
    19^th^ 19th
    H~2~O H2O
    ++Inserted text++ Inserted text
    ==Marked text== Marked text
    [link text](https:// "title") Link
    ![image alt](https:// "title") Image
    `Code` Code 在筆記中貼入程式碼
    ```javascript
    var i = 0;
    ```
    var i = 0;
    :smile: :smile: Emoji list
    {%youtube youtube_id %} Externals
    $L^aT_eX$ LaTeX
    :::info
    This is a alert area.
    :::

    This is a alert area.

    Versions and GitHub Sync
    Get Full History Access

    • Edit version name
    • Delete

    revision author avatar     named on  

    More Less

    Note content is identical to the latest version.
    Compare
      Choose a version
      No search result
      Version not found
    Sign in to link this note to GitHub
    Learn more
    This note is not linked with GitHub
     

    Feedback

    Submission failed, please try again

    Thanks for your support.

    On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?

    Please give us some advice and help us improve HackMD.

     

    Thanks for your feedback

    Remove version name

    Do you want to remove this version name and description?

    Transfer ownership

    Transfer to
      Warning: is a public team. If you transfer note to this team, everyone on the web can find and read this note.

        Link with GitHub

        Please authorize HackMD on GitHub
        • Please sign in to GitHub and install the HackMD app on your GitHub repo.
        • HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.
        Learn more  Sign in to GitHub

        Push the note to GitHub Push to GitHub Pull a file from GitHub

          Authorize again
         

        Choose which file to push to

        Select repo
        Refresh Authorize more repos
        Select branch
        Select file
        Select branch
        Choose version(s) to push
        • Save a new version and push
        • Choose from existing versions
        Include title and tags
        Available push count

        Pull from GitHub

         
        File from GitHub
        File from HackMD

        GitHub Link Settings

        File linked

        Linked by
        File path
        Last synced branch
        Available push count

        Danger Zone

        Unlink
        You will no longer receive notification when GitHub file changes after unlink.

        Syncing

        Push failed

        Push successfully