Skip to content

Files

Latest commit

 

History

History
93 lines (60 loc) · 2.61 KB

CONTRIBUTING.md

File metadata and controls

93 lines (60 loc) · 2.61 KB

Contributing

We welcome contributions to the Unbreakable project! Whether you're fixing bugs, adding new features, improving documentation, or providing feedback, your help is appreciated.

How to Contribute

1. Fork the Repository

  • Click the Fork button at the top right of the repository page to create your own copy of the project.

2. Clone Your Fork

  • Clone your forked repository to your local machine:

    git clone https://github.com/your-username/unbreakable.git
    cd unbreakable

3. Create a New Branch

  • Create a new branch for your feature or bug fix:

    git checkout -b my-feature-branch

4. Make Changes

  • Implement your changes in the codebase.
  • Follow the existing code style and conventions.
  • Include comments and docstrings where appropriate.
  • Update or add documentation as needed.

5. Commit Changes

  • Stage your changes and commit with a descriptive message:

    git add .
    git commit -m "Description of your changes"

6. Push to Your Fork

  • Push your branch to your forked repository on GitHub:

    git push origin my-feature-branch

7. Submit a Pull Request

  • Go to the original repository and click on Pull Requests, then New Pull Request.
  • Select your branch from the compare dropdown.
  • Provide a clear and descriptive title and description for your pull request.
  • Submit the pull request for review.

Reporting Issues

  • If you encounter a bug or have a feature request, please open an issue on GitHub.
  • Provide detailed information about the issue, including steps to reproduce it if applicable.

Code Style Guidelines

  • Follow the existing coding style and structure.
  • Use meaningful variable and function names.
  • Keep functions and classes focused and concise.
  • Write tests for new features or bug fixes when possible.

Testing

  • Ensure that all existing tests pass before submitting a pull request.

  • Add new tests to cover your changes.

  • Run tests using:

    python -m unittest discover tests

Documentation

  • Update the README.md or relevant documentation files if your changes affect them.
  • Ensure that code is well-documented with comments and docstrings.

Communication

  • Feel free to contact the project maintainers for guidance.
  • Be respectful and considerate in all interactions.

License

By contributing to Unbreakable, you agree that your contributions will be licensed under Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0).