Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add Contribution Workflow to CONTRIBUTING.md file #49

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

adebisi4145
Copy link

Fixes

Description

This pull request adds contribution workflow to the CONTRIBUTING.md file which outlines the step-by-step process for contributing to the project

Technical details

  • I added step-by-step guide for contributors (forking, cloning, branching and opening a Pull Request)

Tests

To verify this PR:

  • Navigate to CONTRIBUTING.md file
  • Verify that the workflow steps are steps are accurate

Screenshots

  • Before
    Before

  • After
    After

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@adebisi4145 adebisi4145 requested a review from a team as a code owner October 8, 2024 11:05
@adebisi4145 adebisi4145 requested review from TimidRobot and Shafiya-Heena and removed request for a team October 8, 2024 11:05
Copy link
Member

@TimidRobot TimidRobot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for this work. It's well laid out and written. However, I don't want us to duplicate instructions better found elsewhere.

Please update to reference Foundational technologies — Creative Commons Open Source.

Instead of a list of steps, I would prefer higher level goals with links to appropriate documentation.

@adebisi4145
Copy link
Author

adebisi4145 commented Oct 10, 2024

Thank you for this work. It's well laid out and written. However, I don't want us to duplicate instructions better found elsewhere.

Please update to reference Foundational technologies — Creative Commons Open Source.

Instead of a list of steps, I would prefer higher level goals with links to appropriate documentation.

Thanks for the feedback @TimidRobot, could you please elaborate on what you mean by "high level goals"

@TimidRobot
Copy link
Member

TimidRobot commented Oct 15, 2024

@adebisi4145

Something like (keeping just three bullets):

  • Fork the repository
    • Fork the repository to your github account
    • Clone the project to your local machine
    • Navigate to the cloned project directory
    • Add the original repository as an upstream remote
    • Verify the remote repository
  • Work in a new branch
    • Create a new branch with a descriptive name
    • Make changes
    • Commit changes
    • Push changes to your fork
  • Open a Pull Request (PR) and follow the PR template

Also, it would be helpful to link to GitHub documentation (which may also help organize/inform which steps are listed)

@adebisi4145
Copy link
Author

adebisi4145 commented Oct 18, 2024

Thank you for this work. It's well laid out and written. However, I don't want us to duplicate instructions better found elsewhere.

Please update to reference Foundational technologies — Creative Commons Open Source.

Instead of a list of steps, I would prefer higher level goals with links to appropriate documentation.

Hello @TimidRobot, I've implemented the changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In review
Development

Successfully merging this pull request may close these issues.

[Feature] Add Contribution Workflow to CONTRIBUTING.md
2 participants