| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [View Raw Code] [Original HTTPS Page] |
Thank you for your interest in contributing!
If you find a bug:
We welcome ideas for improvements:
git checkout -b feature/your-feature-namenpm testWrite clear, commented code
Add tests for new functionality
Update documentation
Commit with clear messages
git commit -m "Add: new feature description"
git commit -m "Fix: bug description"
git commit -m "Update: documentation changes"Push to your fork:
git push origin feature/your-feature-nameOpen a Pull Request with:
Wait for review
// Good
function Activity(amount) {
this.amount = amount;
}
Activity.prototype.getAmount = function() {
return this.amount;
};
// Avoid
function Activity(amount){this.amount=amount;}
Activity.prototype.getAmount=function(){return this.amount;}// Good - Clear JSDoc comments
/**
* Set a new amount value with validation
* @param {number} value - The new amount to set
* @returns {boolean} - true if valid, false otherwise
*/
Activity.prototype.setAmount = function(value) {
if (value <= 0) {
return false;
}
this.amount = value;
return true;
};
// Avoid - No comments or unclear comments
Activity.prototype.setAmount = function(value) {
// set amt
if (value <= 0) return false;
this.amount = value;
return true;
};# Run all tests
npm test
# Run specific examples
npm run example:payment
npm run example:refundAdd tests to test.js:
test('Your test description', () => {
const payment = new Payment(100, 'Test');
assert(payment.getAmount() === 100, 'Should equal 100');
});javascript-activity-list/
├── activityList.js # Main implementation
├── test.js # Test suite
├── README.md # Documentation
├── package.json # Package configuration
├── LICENSE # MIT License
├── CONTRIBUTING.md # This file
└── test-cases/ # Test input files
├── payment-example.txt
├── refund-example.txt
├── invalid-amount.txt
└── zero-amount.txt
Feel free to:
We are committed to providing a welcoming and inclusive experience for everyone.
Positive behavior includes:
Unacceptable behavior includes:
Violations can be reported to project maintainers. All complaints will be reviewed and investigated.
Contributors will be:
By contributing, you agree that your contributions will be licensed under the MIT License.
Before submitting your PR, make sure:
Thank you for contributing!
Every contribution, no matter how small, makes this project better.
| Back | FazBrowse Home | New Git URL |