Skip to content

Latest commit

 

History

History
46 lines (26 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

46 lines (26 loc) · 2.08 KB

Contribution Guidelines

Thank you for considering contributing to Ambush - Invoice Generator. We appreciate your efforts to make this project better.

Getting Started

To contribute, follow these steps:

  1. Fork this repository to your GitHub account.
  2. Clone your fork to your local machine.
  3. Create a new branch for your changes.

Code of Conduct

Please note that we have a Code of Conduct that you should read and follow. We want our project to be an open and welcoming environment for everyone.

Reporting Issues

If you find a bug or have a feature request, please create an issue on the Issues page. Make sure to include a clear and detailed description of the issue or feature request.

Making Changes

  1. Before making changes, make sure you're on your development branch.
  2. Create a clear and concise pull request (PR) that describes the changes you're making. Reference any related issues.
  3. Follow the project's coding style and conventions.
  4. Ensure that your changes don't break existing functionality.

Please prioritize open issues: We highly recommend reviewing the open issues before making changes. It's often a good practice to tackle issues that have been reported by others or create new issues for bugs or feature requests you'd like to work on. This helps coordinate efforts and ensures that we address user-reported problems and needs.

Testing

Before submitting a PR, ensure that your changes have been tested and that the existing tests pass.

Documentation

If your changes require updates to the documentation, please include those changes in your PR.

Review and Merge

After you submit a PR, maintainers will review your code. Be prepared to address any feedback or comments. Once your changes are approved, they will be merged into the main codebase.

License

By contributing to this project, you agree to license your contributions under the WTFPL.

Thank you for contributing to Ambush - Invoice Generator!