Tutorials
Make Changes
Learn how to make and test your changes
Make Changes
Now that you have a branch, it's time to make your contribution!
Before You Start
- Read the issue carefully - Understand what needs to be done
- Check contributing guidelines - Follow project-specific rules
- Ask questions - If anything is unclear, ask!
Making Your Changes
Step 1: Open the Project
Use your favorite code editor:
# VS Code
code .
# Or just open the folder in your editorStep 2: Find the Files
Navigate to the files mentioned in the issue or that need changes.
Step 3: Make Your Changes
Edit the files according to the issue requirements. For example:
Fixing a typo in README.md:
# Before
This is a grate project!
# After
This is a great project!Adding a feature:
// Add new function
function calculateTotal(items) {
return items.reduce((sum, item) => sum + item.price, 0);
}Testing Your Changes
Always test your changes before committing!
For Documentation Changes
- Read through your changes
- Check for typos and grammar
- Verify links work
- Preview if possible
For Code Changes
# Run tests
npm test
# or
python -m pytest
# Run the application
npm start
# or
python app.py
# Check for linting errors
npm run lintCheck What You Changed
# See which files you modified
git status
# See the actual changes
git diff
# See changes in a specific file
git diff filename.txtBest Practices
Do's ✅
- Make focused changes - Stick to the issue scope
- Test thoroughly - Ensure nothing breaks
- Follow code style - Match the project's style
- Add comments - Explain complex changes
- Update documentation - If you change functionality
Don'ts ❌
- Don't make unrelated changes - Stay focused
- Don't skip testing - Always test
- Don't ignore errors - Fix any issues
- Don't commit sensitive data - No passwords or API keys
Common Scenarios
Scenario 1: Documentation Fix
# 1. Open the file
# 2. Fix the typo/error
# 3. Save the file
# 4. Preview if possibleScenario 2: Bug Fix
# 1. Reproduce the bug
# 2. Identify the cause
# 3. Fix the code
# 4. Test the fix
# 5. Ensure no new bugsScenario 3: New Feature
# 1. Understand requirements
# 2. Plan your approach
# 3. Implement the feature
# 4. Write tests
# 5. Update documentationNext Steps
Once you're happy with your changes:
Great job making your changes! Now let's commit them. ✏️