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.

Sign up for GitHub

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

Add Contribution Tutorial #12

Merged
merged 2 commits into from
Jan 28, 2024
Merged

Add Contribution Tutorial #12

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd516c7
Add Contribution Tutorial
reggietorres Jan 25, 2024
8984f0e
Update CONTRIBUTING.md
reggietorres Jan 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Contributing Guidelines

Thank you for considering contributing to our project! We appreciate your efforts to improve our codebase. Please follow these guidelines to ensure smooth collaboration and efficient handling of pull requests.

## Pull Request Process

1. **Fork the Repository**: If you haven't already, fork the repository to your GitHub account.

2. **Create a Branch**: Create a new branch for your feature or bug fix. Use a descriptive name that reflects the purpose of your changes.

3. **Make Changes**: Make your changes to the codebase. Ensure that your modifications adhere to the project's coding standards and guidelines.

4. **Test Your Changes**: Before submitting a pull request, test your changes locally to ensure they function as expected. If applicable, write tests to cover your code changes.

5. **Commit Your Changes**: Commit your changes with clear and concise commit messages. Include details about what you have changed and why, Include in-depth documentation on changes both in the commits and in the pull requests, including any relevant context or reasoning.

```bash
git add .
git commit -m "Descriptive commit message"
```
6. **Push Your Changes**: Once you are satisfied with your changes, push your branch to your forked repository.
```bash
git push origin <your-branch-name>
```
7. **Submit a Pull Request**: Go to the original repository (upstream) and create a pull request from your forked branch. Include in-depth documentation on changes both in the commits and in the pull requests, including any relevant context or reasoning.
8. **Review Process**: After submitting your pull request, a project maintainer will review your changes. Be responsive to any feedback or requests for revisions.
9. **Address Feedback**: If requested changes are needed, make the necessary updates to your branch and push the changes. Your pull request will be re-evaluated after the updates.
10. Merge: Once your pull request is approved and all checks pass, it will be merged into the main branch, Congratulations on your contribution!
Loading