Skip to content

Latest commit

 

History

History
59 lines (47 loc) · 2.1 KB

CONTRIBUTING.md

File metadata and controls

59 lines (47 loc) · 2.1 KB

Contributing to Project Template

Thank you for considering contributing to this project! We welcome all contributions, whether they're bug reports, feature suggestions, code improvements, or documentation updates.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue with the following information:

  • A clear and descriptive title.
  • Steps to reproduce the issue.
  • Expected and actual behavior.
  • Any relevant screenshots, logs, or code snippets.

Suggesting Features

Have an idea to improve the project? Open an issue and include:

  • A detailed explanation of the feature.
  • How it would benefit users.
  • Any potential risks or concerns.

Submitting Code Changes

  1. Fork the Repository: Click the "Fork" button on the top right of the repository page.
  2. Clone the Fork: Clone your fork locally.
    git clone https://github.com/your-username/project-template.git
  3. Create a Branch: Use a descriptive name for your branch.
    git checkout -b feature/my-feature
  4. Make Changes: Implement your feature or fix.
  5. Test Your Changes: Ensure your changes work as intended and do not introduce new issues.
  6. Commit Your Changes: Write clear and concise commit messages.
    git commit -m "Add a description of the changes"
  7. Push to Your Fork: Push the changes to your forked repository.
    git push origin feature/my-feature
  8. Open a Pull Request: Go to the original repository and click "New Pull Request".

Code Style

Please follow these guidelines:

  • Use meaningful variable and function names.
  • Write comments where necessary.
  • Keep your changes focused and small.

Documentation Updates

If your changes affect the project's behavior or usage, update the relevant documentation in the README.md or docs/ folder.

Code of Conduct

Please adhere to our Code of Conduct to create a positive and inclusive environment.

Feedback

We appreciate your feedback! If you have questions or suggestions, feel free to open an issue.

Thank you for your contributions! 🚀