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

Update CONTRIBUTING.md #516

Closed
wants to merge 1 commit into from
Closed

Conversation

eliezerjoel
Copy link

@eliezerjoel eliezerjoel commented Oct 3, 2024

Added content for the Your First Code Contribution Section

Closes #515.

Added content for the Your First Code Contribution Section
Copy link

vercel bot commented Oct 3, 2024

@eliezerjoel is attempting to deploy a commit to the lucavallin Team on Vercel.

A member of the Team first needs to authorize it.

Go to the original repository on GitHub.
Click the "Compare & pull request" button that appears for your branch.
Fill in the details for your pull request:
Write a clear title and description of the changes you’ve made.
Copy link
Owner

Choose a reason for hiding this comment

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

Suggested change
Write a clear title and description of the changes you’ve made.
- Write a clear title and description of the changes you’ve made.

Click the "Compare & pull request" button that appears for your branch.
Fill in the details for your pull request:
Write a clear title and description of the changes you’ve made.
Reference the issue your pull request fixes, if applicable (e.g., "Fixes #123").
Copy link
Owner

Choose a reason for hiding this comment

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

Suggested change
Reference the issue your pull request fixes, if applicable (e.g., "Fixes #123").
- Reference the issue your pull request fixes, if applicable (e.g., "Fixes #123").

#### 9. Collaborate and Improve
A maintainer will review your pull request. They might ask for changes, so be ready to discuss and make updates if needed.
Once your pull request is approved, it will be merged into the main branch!
#### 10. Celebrate!
Copy link
Owner

Choose a reason for hiding this comment

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

Suggested change
#### 10. Celebrate!
#### 10. Celebrate!

Fill in the details for your pull request:
Write a clear title and description of the changes you’ve made.
Reference the issue your pull request fixes, if applicable (e.g., "Fixes #123").
#### 9. Collaborate and Improve
Copy link
Owner

Choose a reason for hiding this comment

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

Suggested change
#### 9. Collaborate and Improve
#### 9. Collaborate and Improve

Once you're happy with your changes, push your branch to your forked repository:

`git push origin your-branch-name`
#### 8. Open a Pull Request
Copy link
Owner

Choose a reason for hiding this comment

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

Suggested change
#### 8. Open a Pull Request
#### 8. Open a Pull Request

#### 3. Set Up Your Local Environment
Follow the setup instructions provided in the README.md file to install any necessary dependencies and run the project locally.
Make sure everything is working as expected before making any changes.
#### 4. Create a Branch
Copy link
Owner

Choose a reason for hiding this comment

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

Suggested change
#### 4. Create a Branch
#### 4. Create a Branch

Check the issues page of the repository.
Look for issues labeled "good first issue" or "help wanted". These issues are typically more beginner-friendly and suitable for new contributors.
If you find an issue you're interested in, comment on the issue to let the maintainers know you're planning to work on it.
#### 2. Fork the Repository
Copy link
Owner

Choose a reason for hiding this comment

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

Suggested change
#### 2. Fork the Repository
#### 2. Fork the Repository

Copy link
Owner

@lucavallin lucavallin left a comment

Choose a reason for hiding this comment

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

Thanks, left a few suggestions!

@lucavallin lucavallin closed this Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Updating the 'Your First Code Contribution' section of the README
2 participants