Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 3.13 KB

CONTRIBUTING.md

File metadata and controls

76 lines (50 loc) · 3.13 KB
Raw

Contributing to Charwiki

First off, thank you for considering contributing to Charwiki! Your help is greatly appreciated.

The following is a set of guidelines for contributing to Charwiki on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table of Contents

How to Report Issues

If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to our GitHub Repository. After that, you can submit a Pull Request with a fix.

When filing an issue, please include:

  • A clear and descriptive title.
  • A detailed description of the problem and steps to reproduce it.
  • Any relevant log files, error messages, or screenshots.

How to Submit Pull Requests

  1. Fork the Repo: Create a personal fork of the repository on GitHub.

  2. Clone the Forked Repo: Clone your forked repository to your local machine.

    git clone https://github.com/je-sendra/Charwiki.git

  3. Create a Branch: Create a new branch for your feature or bugfix.

    git checkout -b feature/your-feature-name

  4. Make Changes: Make your changes to the codebase.

  5. Commit Changes: Commit your changes with a clear message, please follow the Conventional Commits specification.

    git commit -m "Description of the changes"

  6. Push Changes: Push your changes to your forked repository.

    git push origin feature/your-feature-name

  7. Create Pull Request: Create a pull request to merge your changes into the main repository. Please include:

    • A clear title and description of your changes.
    • A reference to the issue your pull request addresses (if applicable).

Code Style

To keep the codebase clean and maintainable, please adhere to the following guidelines:

  • Follow the coding style and conventions used in the project.
  • Write clear, concise, and descriptive commit messages, please adhere to the Conventional Commits specification.
  • Ensure your code is well-documented and comments are included where necessary.
  • Write tests for new features and bug fixes, and ensure all tests pass before submitting a pull request.

Please see the docs/contributing folder for more details on the coding style and conventions, and contributing guidelines used in the project.

Code of Conduct

We expect all contributors to adhere to our Code of Conduct. Please read it to understand the expected behavior when interacting in the project.

License

By contributing to Charwiki, you agree that your contributions will be licensed under the AGPL v3 License.