Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (29 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

39 lines (29 loc) · 1.47 KB

Contributing to Learning Chunk

First off, thanks for taking the time to contribute! This is a personal learning log, but I welcome feedback and improvements that help make these resources better for everyone.

🚀 How to Contribute

1. Reporting Bugs

  • Use the GitHub Issues tab to report any bugs in the implementations.
  • Provide a clear description and steps to reproduce.

2. Suggesting Improvements

  • If you have a more efficient way to solve a problem or a better architectural pattern, please open an issue or a PR.

3. Pull Request Process

To maintain the quality of this repository, please follow these guidelines:

  1. Branch Naming: Use descriptive branch names (e.g., feature/add-sql-joins or fix/async-bug).
  2. Standardization: Ensure your code follows the root .eslintrc.json guidelines. Run npm run lint before committing.
  3. Documentation: Every new project or lesson MUST include a README.md based on the README Template.
  4. Kebab-Case: All files and directories must use kebab-case.
  5. Atomic Commits: Keep your commits small and focused on a single change.

🛠 Development Setup

  1. Clone the repository.
  2. Install root dependencies: 
    npm install
  3. Run linter: 
    npm run lint

📜 Code of Conduct

Please be respectful and professional in all interactions.

By contributing, you agree that your contributions will be licensed under the MIT License.