Skip to content

Latest commit

 

History

History
60 lines (46 loc) · 2.29 KB

CONTRIBUTING-LIGHT.md

File metadata and controls

60 lines (46 loc) · 2.29 KB

Contributing to First Pull Request - light version

Thank you for your interest in contributing to First Pull Request!

Below is step-by-step instruction how to make your changes in this repo's 'text/changeme.md' file. If something is still unclear please ask questions in discussions.

More advanced contribution is described in [CONTRIBUTING.md].

  1. Fork the Repository: Click the "Fork" button at the top right of this page to create a copy of this repository under your GitHub account.

  2. Clone Your Fork:

    git clone https://github.com/your-username/project-name.git
cd project-name

  3. Make a new branch: Use the following format for branch names:

  • feature/<short-description>
  • fix/<short-description>
  • chore/<short-description>
  • docs/<short-description> 
    git checkout -b docs/text-file

  1. Edit the file: Edit text/changeme.md with the editor of your choice. For example write there your name or where you're from. Adding or removing files is not allowed for now and will be blocked by CI workflow.

  2. Commit the changes: Use Conventional Commits format:

    type(scope): description
  • type: feat, fix, docs, chore, refactor, test
  • scope: (optional) The area of code affected
  • description: Short and imperative 
    git commit -am 'fix: fix the text of a file'

  1. Push the changes: This step will push your changes to your forked repository. (Still need to put changes to this original repo with PR!)

    git push

  2. Create a Pull Request: GitHub will show a banner at the top of your repo's main page saying that there is a branch and suggesting to create a PR for it. Or you could go to "Pull requests" tab and create new pull request there. Pull request is a suggestion for repo owner to include your changes into the repo.

  3. Follow your PR: We will review and merge your pull request in due course. You'll see your changes in this repo and your name among contributors.

Code of Conduct

Please adhere to the Code of Conduct in all your interactions with the project.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.