Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

57 lines (38 loc) · 1.89 KB
Raw

Contributing to the project

Thank you for your interest in contributing to this project! We welcome contributions from everyone. By participating in this project, you agree to abide by the code of conduct.

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Pull Requests

Adhering to the following process is the best way to get your work included in the project:

  1. Fork the project, clone your fork, and configure the remotes:
# Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/my-first-contribution.git
# Navigate to the newly cloned directory
cd my-first-contribution
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/Open-reSource/my-first-contribution.git
  1. If you cloned a while ago, get the latest changes from upstream:
git checkout main
git pull upstream main
  1. Create a new topic branch off the main branch to contain your change:
git checkout -b <topic-branch-name>
  1. Commit your changes with the following commit message:
git commit -am "Add my GitHub username to the CONTRIBUTORS.md file"
  1. Locally merge (or rebase) the upstream development branch into your topic branch:
git pull [--rebase] upstream main
  1. Push your topic branch up to your fork:
git push origin <topic-branch-name>
  1. Open a Pull Request with the following title "Add my GitHub username to the CONTRIBUTORS.md file" against the main branch. The description is optional.

License

By contributing your code, you agree to license your contribution under the MIT License.