Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (49 loc) · 2.84 KB

CONTRIBUTING.md

File metadata and controls

63 lines (49 loc) · 2.84 KB

Contributing to BillingSystem 🚀

First off, thank you for considering contributing to BillingSystem. It's people like you that make BillingSystem such a great tool. 🎉

Getting Started 🛠

Before you begin:

  • Ensure you have installed all necessary dependencies as outlined in the project's README.md. 📚
  • Make sure you have a GitHub account. (No? How about a time machine to 2008? 😜)
  • Submit an issue if there are no issues related to the problem you're solving or the feature you're adding. (Be the change you want to see in the repo! 🌟)

Making Changes ✏️

  1. Fork the repository on GitHub. (It's like cloning, but more GitHub-y!)
  2. Clone your fork locally: 
    git clone https://github.com/yourusername/BillingSystem.git
  3. Create a branch for your changes: 
    git checkout -b your-branch-name
  4. Make your changes, adhering to the coding conventions used throughout the project. Write meaningful commit messages, and split large changes into multiple commits if necessary. (Commit like a boss! 💼)
  5. Install all requirements by following the steps provided in the README.md, including running bash install_dependencies.sh for all external dependencies. (Let the magic happen! 🪄)
  6. Test your changes thoroughly to ensure they are free of syntax and logic errors and do not introduce any new bugs. (Be a bug hunter. 🐛🔫)
  7. Update the README.md if necessary, with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters.

Submitting Your Changes 📮

  1. Push your changes to your fork: 
    git push origin your-branch-name
  2. Submit a pull request through the GitHub website using your branch. Include a clear description of the changes and any relevant issue numbers. (PRs are like gifts 🎁 - it's the thought that counts!)

After Your Pull Request is Merged 🎊

After your pull request is merged, you can safely delete your branch and pull the changes from the master (upstream) repository:

  1. Switch to your master branch: 
    git checkout master
  2. Delete the branch locally: 
    git branch -d your-branch-name
  3. Pull the latest changes: 
    git pull upstream master
  4. Delete the branch on your forked repository: 
    git push origin --delete your-branch-name

Additional Resources 📚

Thank you for your contributions! Let's make BillingSystem the best it can be, together! 💪🎈