Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (46 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

72 lines (46 loc) · 1.87 KB

Contributing to pyxmlcheck

Thank you for your interest in contributing to pyxmlcheck! We welcome contributions from everyone.

Ways to Contribute

  1. Reporting Bugs: If you find a bug, please open an issue with a clear description and steps to reproduce.
  2. Suggesting Features: We're always looking for ways to improve! Open an issue to suggest a new feature.
  3. Code Contributions:
    • Fixing bugs.
    • Implementing new features.
    • Improving documentation.
    • Adding tests.

Development Workflow

1. Fork and Clone

Fork the repository on GitHub and clone it to your local machine.

git clone https://github.com/YOUR_USERNAME/pyxmlcheck.git
cd pyxmlcheck

2. Set Up Environment

Create a virtual environment and install dependencies.

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -r requirements.txt

3. Create a Branch

Always work on a new branch for your changes.

git checkout -b my-awesome-feature

4. Make Your Changes

Implement your feature or fix. Ensure your code follows existing styles and is well-documented.

5. Test Your Changes

Run the script against various XML and HTML files to ensure it still works as expected and your changes are correct.

6. Commit and Push

Commit your changes with clear, descriptive commit messages.

git add .
git commit -m "Add feature: <description>"
git push origin my-awesome-feature

7. Open a Pull Request

Go to the original repository on GitHub and open a pull request from your branch.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Questions?

If you have any questions, feel free to open an issue or contact the maintainer at rasyaakbarnugraha@gmail.com.