Skip to content

Latest commit

 

History

History
68 lines (58 loc) · 3.1 KB

CONTRIBUTING.MD

File metadata and controls

68 lines (58 loc) · 3.1 KB

Contributing to MyAngularStarter

First off, thank you for considering contributing to MyAngularStarter! 🎉 Your contributions are essential in helping improve and grow this project.

How Can I Contribute?

Reporting Bugs

If you find a bug in the project, please open an issue with a clear and detailed description. Include steps to reproduce the bug, and screenshots or code snippets if applicable.

  1. Navigate to the issues page.
  2. Check for existing issues before creating a new one.
  3. Provide as much detail as possible:
    • Node, npm versions
    • Angular version
    • Steps to reproduce
    • Expected and actual behavior

Suggesting Features

We are always looking to improve MyAngularStarter. If you have ideas to enhance the project, please submit a feature request:

  1. Navigate to the issues page.
  2. Check for existing requests before creating a new one.
  3. Describe the feature, why it's needed, and how it could be implemented.

Pull Requests

We welcome code contributions in the form of pull requests (PRs). To ensure a smooth PR process:

  1. Fork the repository: Create your own fork of the repository by using the 'Fork' button.
  2. Clone your fork: 
    git clone https://github.com/yourusername/my-angular-starter.git
cd my-angular-starter
  3. Create a branch for your changes: 
    git checkout -b feature/your-feature-name
  4. Make changes in your local repository.
  5. Commit your changes: 
    git commit -m "feat: Add a meaningful commit message"
  6. Push to the branch: 
    git push origin feature/your-feature-name
  7. Open a Pull Request: Navigate to the original repository and click 'Compare & pull request'.

Code Quality and Style

Please ensure your code follows our code quality standards:

  • Use ESLint for linting JavaScript and TypeScript code.
  • Follow the code style enforced by Prettier. Run npm run format before committing to format your code.
  • Add tests for new features or bug fixes. Consider using Jest and ng-mocks for testing.

Commit Messages

We follow Conventional Commits. Here are some examples:

  • feat: Add a new feature
  • fix: Fix a bug
  • docs: Update documentation
  • style: Improve code formatting
  • refactor: Refactor code without changing functionality
  • test: Add or update tests
  • chore: Maintenance task (build, CI, dependencies)

Questions and Support

If you have any questions or need further clarification, please feel free to open a discussion or reach out via email at [[email protected]].

Code of Conduct

This project adheres to a Code of Conduct. By participating, you are expected to uphold this code. Please report any unacceptable behavior to [[email protected]].

Thank you for contributing! 🚀