Skip to content

Latest commit

 

History

History
56 lines (41 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

56 lines (41 loc) · 1.87 KB

Contributing to ElementalDB

Thank you for considering contribution to our project! We appreciate your time and effort. This guide outlines how to contribute effectively.

How to Contribute

  1. Fork the Repository:

    • Click the "Fork" button in the top right corner of the repository page.
  2. Clone Your Fork:

    git clone http://github.com/YOUR_USERNAME/your-repo-name.git
    cd your-repo-name
  3. Create a New Branch:

    • It's best practice to create a new branch for your changes.
    git checkout -b feature/your-feature-name
  4. Make Your Changes:

    • Make your changes in the codebase.
  5. Test Your Changes:

    • Ensure everything works as expected. Run the app locally to verify.
  6. Commit Your Changes:

    git add --a
    git commit -m "Add a descriptive commit message"
  7. Push to Your Fork:

    git push origin feature/your-feature-name
  8. Create a Pull Request:

    • Go to the original repository where you want to propose your changes.
    • Click on the "New Pull Request" button.
    • Select your fork and the branch you created, then create the pull request.

Guidelines

  • Follow the Coding Style: Please ensure that your code follows the existing style in the repository.
  • Add Comments: If necessary, add comments to clarify complex sections of your code.
  • Add Docstrings: If you add new functions or classes in the existing codebase, add docstrings to your every functions and classes.
  • Documentation: If you add features, please update the documentation accordingly.

Issues and Suggestions

If you encounter any issues or have suggestions for improvement, please open an issue in the repository.

Thank You!

Thank you for your contribution! Your efforts make this project better for everyone. Happy coding, and welcome to Hacktoberfest!