open-sauced / intro

Empowering Your Open Source Journey: From First Contribution to Project Leadership

Home Page:https://opensauced.pizza/learn

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Feature: Add a step to create new branch in the CONTRIBUTING file

adiati98 opened this issue Β· comments

Type of feature

πŸ“ Documentation

Current behavior

We've noticed that some contributors made their changes directly on the main branch.

Suggested solution

We want to make clear that changes are made on new branch and not directly on the main branch.

  • Add step 4 in the "Setup the Project Locally" section in the CONTRIBUTING file with copy as follow:

    4. Create a new branch to work on your changes.
    
       ```bash
       git checkout -b YOUR-BRANCH-NAME
       ```
    
       Replace "YOUR-BRANCH-NAME" with a descriptive name for your branch β€” for example, `feat/add-submit-button`.
  • Change number 4 to 5.

The code is located here:

intro/CONTRIBUTING.md

Lines 33 to 39 in c3c8636

3. Navigate to and open the project in your code editor.
```bash
cd intro
```
4. Run the project.


Important

If you've worked on a good first issue or beginners only issue in any of our community repositories before, please refrain from taking this issue.
We may remove you from the assignees and not accept your pull request if you choose to proceed.

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs

hey @adiati98, I've made a PR could u review it #150

@hx4nn you should be assigned the issue before creating a PR. You can use the .take command to self-assign.

.take

Hey @hx4nn
You've been assigned to issue #146.

And as stated in the important note on this issue, contributors may only take one good first issue.

That been said, I'll unassign you from this issue.

Thanks 😊

.take