Skip to content

Latest commit

 

History

History
130 lines (63 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

130 lines (63 loc) · 2.49 KB

Contributing to Txtmax

Thank you for considering contributing to Txtmax! We welcome all contributions, whether it’s bug fixes, new features, documentation improvements, or suggestions. Follow this guide to get started.

📜 Code of Conduct

By participating, you agree to follow our Code of Conduct to ensure a welcoming and inclusive environment.

🛠 How to Contribute

1️⃣ Fork and Clone the Repository

  1. Click the Fork button on the Txtmax GitHub repository.
  2. Clone your fork: 
    git clone https://github.com/YOUR-USERNAME/Txtmax.git
cd Txtmax

2️⃣ Set Up the Development Environment

  1. Ensure you have GCC and Make installed.

  2. Compile Txtmax:

cd src
make

3️⃣ Create a Branch

Create a new branch for your feature or bug fix:

git checkout -b feature-or-fix-name

📝 Contribution Types

✅ Reporting Issues

If you find a bug or have a feature request, open an issue here.

Provide clear details, steps to reproduce (if applicable), and expected vs. actual behavior.

🏗️ Adding Features or Fixing Bugs

  1. Check existing issues or create a new one before working on it.

  2. Follow the Coding Guidelines.

  3. Test your changes before committing.

📖 Improving Documentation

Help improve the README.md, CONTRIBUTING.md, and docs/.

Ensure clarity, consistency, and correct formatting.

📌 Coding Guidelines

Use C standard libraries (avoid unnecessary dependencies).

Maintain clean, readable, and commented code.

Follow the existing code style and structure.

Test all new features before submitting.

🔄 Commit and Push Changes

  1. Commit your changes:

git add . git commit -m "Add feature: "

  1. Push to your fork:

git push origin feature-or-fix-name

📩 Submitting a Pull Request

  1. Open a Pull Request (PR) from your forked repository to the main branch of Txtmax.
  2. Follow the PR template and describe your changes.
  3. Wait for review and respond to feedback.

🎯 Additional Notes

  • Keep your PR small and focused.
  • If adding a new command, update the help command and documentation.
  • Ensure no breaking changes are introduced.

❤️ Thank You!

We appreciate your contribution! If you have any questions, feel free to ask in issues or discussions.

🚀 Happy Coding!

This guide ensures a structured and easy contribution process for new developers. Let me know if you need modifications!