Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (58 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

72 lines (58 loc) · 1.91 KB

Contributing to fxCreate

Thank you for your interest in contributing to fxCreate! We welcome contributions of all kinds, including bug reports, feature requests, code contributions, and documentation improvements.

Getting Started

1. Fork and Clone the Repository

  1. Fork the repository you want to contribute to.
  2. Clone your fork locally: 
    git clone https://github.com/your-username/fxCreate.git
  3. Navigate into the project directory: 
    cd fxCreate
  4. Add the upstream repository: 
    git remote add upstream https://github.com/fxCreate/fxCreate.git

2. Install Dependencies

Most of our projects use Node.js and TypeScript. Install dependencies using:

npm install

Issue Guidelines

  • Bug Reports: Provide a clear description of the issue, steps to reproduce, expected behavior, and actual behavior.
  • Feature Requests: Explain the problem the feature would solve and any possible implementation details.
  • Enhancements: Describe improvements to existing functionality.

Code Contributions

1. Follow Coding Standards

  • Use Prettier for formatting (if applicable): 
    npm run format
  • Lint Your Code: 
    npm run lint
  • Write Descriptive Commit Messages: 
    git commit -m "feat: add new CLI command for resource creation"

2. Testing

Run tests before submitting your PR:

npm test

3. Push and Create a Pull Request

  1. Push your changes: 
    git push origin main
  2. Open a pull request on GitHub with a detailed description.
  3. Ensure all checks pass and be open to feedback from maintainers.

Code of Conduct

All contributors must adhere to our Code of Conduct.

License

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

Thank you for helping improve fxCreate! 🚀