Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
79 lines (52 loc) · 2.63 KB

CONTRIBUTING.md

File metadata and controls

79 lines (52 loc) · 2.63 KB

Contributing to mapify-cli

Thank you for your interest in contributing to mapify-cli! We welcome contributions of all kinds, including code improvements, bug fixes, documentation updates, and more.

How to Contribute

Reporting Issues

If you encounter any bugs or have feature requests, please open an issue on the GitHub repository. When reporting issues, please provide as much detail as possible, including steps to reproduce the issue and any relevant screenshots.

Submitting Code

  1. Fork the Repository: Start by forking the repository to your own GitHub account.

  2. Clone Your Fork: Clone the forked repository to your local machine.

    git clone https://github.com/your-username/mapify-cli.git

  3. Create a Branch: Create a new branch for your changes.

    git checkout -b my-feature-branch

  4. Make Changes: Make your changes and ensure that they follow the project's coding style and conventions.

  5. Write Tests: If you are adding new features or fixing bugs, please include appropriate tests to verify your changes.

  6. Update Documentation: Update the documentation if your changes affect how the package is used or configured.

  7. Commit Changes: Commit your changes with a descriptive commit message.

    git add .
git commit -m "Add feature X or fix bug Y"

  8. Push Changes: Push your changes to your forked repository.

    git push origin my-feature-branch

  9. Create a Pull Request: Open a pull request (PR) from your branch to the main repository. In your PR description, provide a clear explanation of the changes and why they are being made.

Code of Conduct

Please adhere to our Code of Conduct while interacting with the community and contributing to the project. Be respectful and considerate in all communications.

Development Environment

To set up a development environment, follow these steps:

  1. Install Dependencies:

    npm install

  2. Run Tests:

    npm test

  3. Build the Project:

    npm run build

Style Guide

  • Use Prettier for code formatting.
  • Follow ESLint rules for JavaScript/TypeScript code quality.

Additional Resources

Thank You!

Your contributions help make mapify-cli better for everyone. We appreciate your time and effort in helping us improve the project!