Welcome to proj-management! We appreciate your interest in contributing to our open-source project management tool. Before you get started, please take a moment to review the following guidelines.
We expect all contributors to adhere to our Code of Conduct. Please make sure to read and follow these rules when participating in our project.
Before you start contributing, make sure you have the following prerequisites:
If you encounter a bug in proj-management, please open an issue with a detailed description of the problem. Include steps to reproduce the issue if possible. Be sure to check if a similar issue already exists before creating a new one.
If you have an idea for a new feature or enhancement, please open an issue and describe the feature you'd like to see. We encourage you to discuss the proposed feature with the community before starting any work.
We welcome contributions via pull requests (PRs). Here's how you can contribute:
- Fork the repository and create a new branch from the
mainbranch. - Make your changes, ensuring that your code adheres to our coding standards.
- Test your changes thoroughly.
- Submit a pull request, explaining your changes, the problem they solve, and any relevant details.
Please ensure your PR includes:
- A clear and concise description of your changes.
- Any necessary documentation updates.
- Tests (if applicable).
- Follow the style guide for coding standards.
- Write clear and meaningful commit messages.
- Keep pull requests focused and atomic, addressing a single issue or feature.
- Avoid making unrelated changes in a single pull request.
- Ensure your code is well-documented, and update documentation as needed.
- Write and run tests for your code, and ensure existing tests pass.
By contributing to proj-management, you agree that your contributions will be licensed under the project's LICENSE.
Thank you for your interest in contributing to proj-management! Your contributions help make this project better.