GithubHelp home page GithubHelp logo

Comments (5)

senatormailman avatar senatormailman commented on July 17, 2024 1

Hi, I would like to contribute to this. I can elaborate on how I feel to implement your points:

  1. First, I am not sure which you would prefer, but I was thinking of adding a CONTRIBUTE.md file to show the instructions. I can also just add this to README.md. Let me know which you would prefer.
  2. Instructions on how to correctly get an issue I would showcase how to find issues for your project (Probably link to your open issues in the guide) and then show that you must notify the maintainer on the specified issue. Much like what I am doing now.
  3. What to put in PRs (make an individual pull request for each suggestion) I would specify with an example. (Say there is an issue you are resolving, but you also have a change for an issue you haven't claimed. The appropriate order would be to only perform a pull request for the issue you are addressing.)
  4. I was also thinking of linking to Digital Ocean's guide for making pull requests somewhere as it has been really helpful for keeping repos in a logical order.

Let me know if you have any suggestions and I will get to work on this if you approve.

from task-sprinter.

senatormailman avatar senatormailman commented on July 17, 2024 1

I'm sorry I neglected a section!

How to name PRs (the pull request and commit should have a useful title)

I would include mentioning the issue number either in the title or description of the PR as well as succinctly titling the PR (Example: "Added Contribution Guide" or "Fixed Typos on ") which does also tie in to why PRs should be Individual.

from task-sprinter.

gmelodie avatar gmelodie commented on July 17, 2024 1

I pretty much agree with all you suggested 🤣

I would include mentioning the issue number either in the title or description of the PR as well as succinctly titling the PR (Example: "Added Contribution Guide" or "Fixed Typos on ") which does also tie in to why PRs should be Individual.

Ooh this is nice I hadn't thought about that 😃

Feel free to get right on it, happy contributing! 😄

from task-sprinter.

senatormailman avatar senatormailman commented on July 17, 2024

After re-reviewing, I do see you would like the Contribution section in the README so my first point is tackled.

from task-sprinter.

gmelodie avatar gmelodie commented on July 17, 2024

Closed by #12

from task-sprinter.

Related Issues (6)

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.