Skip to content

Added beginner-friendly contribution steps#21211

Closed
mitaliiiiiiii wants to merge 1 commit intorapid7:masterfrom
mitaliiiiiiii:master
Closed

Added beginner-friendly contribution steps#21211
mitaliiiiiiii wants to merge 1 commit intorapid7:masterfrom
mitaliiiiiiii:master

Conversation

@mitaliiiiiiii
Copy link
Copy Markdown

Added a beginner-friendly step-by-step contribution guide to the Using-Git.md documentation.

This helps new contributors understand how to fork, clone, create branches, commit changes, and submit pull requests in a simple way.

@mitaliiiiiiii
Copy link
Copy Markdown
Author

Hi, I have added beginner-friendly steps to improve clarity for new contributors. Please let me know if any changes are needed.

Copy link
Copy Markdown
Contributor

@smcintyre-r7 smcintyre-r7 left a comment

Choose a reason for hiding this comment

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

What's contained within this PR is a basic workflow to commit a single file using git. Nothing within it is specific to Metasploit. If the instructions we have are insufficient for new contributors, then what we might be able to do is reference a beginners guide that could provide even more detail that what is contained here without also duplicating it.

What would you think about removing this section and instead linking to a 3rd party guide that would provide additional details without the duplication?

@msutovsky-r7 msutovsky-r7 added the needs-unique-branch The pull request must not be from the master branch label Apr 1, 2026
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 1, 2026

Thanks for your pull request! We require for all contributed code to come from a from a unique branch in your repository before it can be merged.

Please create a new branch in your fork of framework and resubmit this from that branch.

If you are using Git on the command line that may look like:

# Checkout the master branch
git checkout master

# Create a new branch for your feature
git checkout -b <BRANCH_NAME>

# Add your new files
git add modules/my-cool-new-module

# Commit your changes with a relevant message
git commit

# Push your changes to GitHub
git push origin <BRANCH_NAME>

# Now browse to the following URL and create your pull request!
# - https://github.com/rapid7/metasploit-framework/pulls

This helps protect the process, ensure users are aware of commits on the branch being considered for merge, allows for a location for more commits to be offered without mingling with other contributor changes and allows contributors to make progress while a PR is still being reviewed.

Please do resubmit from a unique branch, we greatly value your contribution! 🎉

@github-actions github-actions bot closed this Apr 1, 2026
@github-project-automation github-project-automation bot moved this from Todo to Done in Metasploit Kanban Apr 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-unique-branch The pull request must not be from the master branch

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants