Git Product home page Git Product logo

Comments (6)

BenjaminCCross avatar BenjaminCCross commented on June 27, 2024 1

What should be in this contributing document? One big thing I can think of is this.

  • When making a pull request, reference a specific issue. If there is no specific issue then make one. This will allows to keep track of issues as well as see growth and change.

from bookomatic.

AlbertCoolGuy avatar AlbertCoolGuy commented on June 27, 2024

from bookomatic.

BenjaminCCross avatar BenjaminCCross commented on June 27, 2024

Here are some useful tips: link.
More specific ideas:

  • When making a pull request include the number of the issue in the title.
  • Use clear and succinct commit messages. Useful but long guide: link
  • Keep your pull request to one issue. Smaller is better.
  • When describing the bull request don't assume past history with the issue.
  • If you need help please include areas of concern to help reviewers know what they can do.
  • add screen shots if you are including visual changes
  • @mention devs that you specifically want to see the PR and mention why. Such as having experience with the issue.

Suggestions? Also ideas on other forms of contribution ie documentation, issue gardening etc.?

from bookomatic.

AlbertCoolGuy avatar AlbertCoolGuy commented on June 27, 2024

from bookomatic.

BenjaminCCross avatar BenjaminCCross commented on June 27, 2024

Yeah absolutely. Though now I am concerned it won't be up to par...

from bookomatic.

BenjaminCCross avatar BenjaminCCross commented on June 27, 2024

@AlbertCoolGuy @KalleHallden this issue can be closed after the merge. I can't close it for some reason, but as admin or the person who opened it one of you can.

from bookomatic.

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.