CONTRIBUTING.md

Contributing

Thank you for considering contributing to CountryData.js! We welcome all contributions, whether they are bug reports, feature suggestions, or code improvements. Please ensure that your contributions align with the project's goals and maintain high-quality standards.

How to Contribute

1. Fork the Repository

   • Fork the repository from the dev branch to ensure you are working with the latest code.

2. Create a New Branch

   • Create a new branch for your feature or bug fix. Use a descriptive name for your branch (e.g., feature/add-country-flag or bugfix/fix-country-name).

3. Make Your Changes

   • Implement your changes, ensuring that the code follows the project's coding conventions and style guidelines.

4. Write Tests

   • Write tests to cover your changes. Ensure that all existing tests pass by running the test suite.

5. Commit Your Changes

   • Commit your changes with a descriptive commit message. Follow the Conventional Commits specification for your commit messages.

6. Push Your Branch

   • Push your branch to your forked repository on GitHub.

7. Submit a Pull Request

   • Open a pull request to the main repository. Provide a clear and detailed description of your changes, including any relevant issue numbers.

8. Review Process

   • Your pull request will be reviewed by the maintainers. Please be responsive to any feedback or requests for changes.

9. Merge

   • Once your pull request is approved, it will be merged into the main branch.

10. Celebrate

    • Thank you for your contribution! 🎉

Additional Notes

• Ensure your code is well-documented and follows the project's coding standards.
• If you are adding a new feature, consider updating the documentation to reflect your changes.
• Be respectful and considerate in your interactions with the community.

We appreciate your contributions and look forward to working with you to improve CountryData.js!