Skip to content

Latest commit

 

History

History
57 lines (36 loc) · 3.14 KB

CONTRIBUTING.md

File metadata and controls

57 lines (36 loc) · 3.14 KB

Contributing to ShowTimeAgo

👋 Welcome to the ShowTimeAgo Utility!

Thank you for considering contributing to the ShowTimeAgo project. This application aims to provide a seamless, minimal-configuration utility for displaying time in a human-readable "time ago" format. We want to make life easier for developers by keeping things as simple and intuitive as possible.

Contribution Guidelines

We welcome all contributions, whether it's new ideas, features, bug fixes, or improvements. Here are some guidelines to help you get started:

🌟 New Features & Ideas

If you have a cool idea or feature that you think should be included, please follow these steps:

  1. Open an Issue: Start by opening an issue to discuss your idea.
  2. Fork the Repository: Fork the project to work on your idea.
  3. Create a Development Branch: Name your branch appropriately, such as feature-new-idea.
  4. Push Your Changes: Push your changes to your fork.
  5. Submit a Pull Request: Open a pull request to the development branch of the main repository.

🐛 Bug Fixes

If you find any bugs or issues, please help us by doing the following:

  1. Open an Issue: Describe the bug in detail by opening an issue.
  2. Fork the Repository: Fork the project to fix the bug.
  3. Create a Patch Branch: Name your branch appropriately, such as patch-bug-fix.
  4. Push Your Changes: Push your changes to your fork.
  5. Submit a Pull Request: Open a pull request to the patch-bugs branch of the main repository.

🧪 Tests

If you would like to contribute tests, please follow these steps:

  1. Fork the Repository: Fork the project to add your tests.
  2. Create a Test Branch: Name your branch appropriately, such as test-new-tests.
  3. Push Your Changes: Push your changes to your fork.
  4. Submit a Pull Request: Open a pull request to the test branch of the main repository.

🔄 CI/CD Pipelines

If you would like to contribute to the CircleCI or GitHub Actions configurations, please follow these steps:

  1. Fork the Repository: Fork the project to add your CI/CD configurations.
  2. Create a CI Branch: Name your branch appropriately, such as ci-actions-pipeline.
  3. Push Your Changes: Push your changes to your fork.
  4. Submit a Pull Request: Open a pull request to the ci-actions branch of the main repository.

🚀 Production Branch

The main branch is the production branch. After thorough testing and validation, authorized contributors or maintainers will merge changes from development, patch-bugs, test, or ci-actions branches into the main branch.

Final Note

Thank you for all your contributions and efforts to improve the ShowTimeAgo utility! Together, we can make this tool more robust and useful for everyone. 🙌

Happy coding! 💻