Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (31 loc) · 3.03 KB

CONTRIBUTING.md

File metadata and controls

52 lines (31 loc) · 3.03 KB

Contributing to OpenDDD.NET

Welcome to OpenDDD.NET! We appreciate your interest in contributing to our open-source framework. By contributing, you can help us improve and enhance the project, making it better for everyone. This document will guide you through the contribution process.

Code of Conduct

Before getting started, please read and adhere to our Code of Conduct. We expect all contributors to follow the guidelines. There's no special treatment, everyone's ideas are evaluated equally.

Getting Started

To contribute to OpenDDD.NET, you'll need to have a GitHub account. If you don't have one yet, you can sign up here.

Reporting Issues

If you encounter a bug, have a suggestion, or want to request a new feature, please check if the issue has already been reported by searching through the issue tracker. If it hasn't been reported yet, feel free to open a new issue with all the necessary details.

When reporting an issue, please provide a clear and concise description, along with any relevant information, such as error messages, steps to reproduce the issue, or sample code. This will help us understand and address the problem more effectively.

Contributing Code

If you want to contribute code to OpenDDD.NET, follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Create a new branch from the master branch for your changes.
  4. Make your modifications and ensure they adhere to our coding conventions.
  5. Write appropriate tests for your changes, ensuring they pass.
  6. Commit your changes with a descriptive and meaningful commit message.
  7. Push your branch to your forked repository on GitHub.
  8. Open a pull request (PR) against the develop branch of the main repository.

Please ensure that your code follows our coding standards and conventions. If you're unsure about any guidelines, feel free to reach out to the project maintainers for clarification.

Pull Request Guidelines

When submitting a pull request, please make sure to:

  • Provide a clear and descriptive title for your pull request.
  • Include a detailed description of the changes you've made.
  • Reference any related issues by using keywords like "Fixes #issue_number" in the description.

Our team will review your pull request as soon as possible. We may provide feedback or request further changes before merging it into the main codebase.

Code Licensing

By contributing to OpenDDD.NET, you agree to license your contributions under the project's GPLv3 License. This means that your code will be available to others under the same license terms.

Conclusion

Thank you for considering contributing to OpenDDD.NET! Your help is invaluable in making the project better for everyone. If you have any questions or need assistance, don't hesitate to reach out to the project maintainers or the community.

Happy coding!