We are thrilled that you are interested in contributing to Edgar! This document provides guidelines for contributing to this project. By participating in this project, you agree to abide by its terms.
There are many ways to contribute to Edgar:
- Submit bugs and help us verify fixes.
- Submit pull requests for bug fixes or new features and improvements.
- Review the source code changes.
- Fork the repository on GitHub.
- Clone the forked repository to your local machine.
- Create a new branch for your fix or feature.
- Write clean, readable, and maintainable code.
- Follow the existing code style and conventions.
- Make sure your code is well-documented.
- Use clear and descriptive commit messages.
- Begin the message with a short summary of your changes (limit to 50 characters).
- Follow with a detailed description if necessary.
- Create a pull request from your branch to the main Edgar repository.
- In the pull request, describe what your code does and why you have chosen that solution.
- Ensure your code passes all tests and is free of linting errors.
- Use the GitHub issues tracker to report bugs.
- Describe the bug and include specific instructions on how to reproduce it.
- Include any relevant logs, error messages, or screenshots.
- Treat everyone with respect and kindness.
- Be open to different viewpoints and ideas.
- Follow the project’s code of conduct.
Feel free to reach out to us if you need any help or have questions regarding contributing.
Your contributions to open source, no matter how small, make projects like Edgar possible. Thank you for your involvement!