Skip to content

Latest commit

 

History

History
78 lines (39 loc) · 3.23 KB

CONTRIBUTING.md

File metadata and controls

78 lines (39 loc) · 3.23 KB
Raw

drf-api-action Support

Welcome to the support page for drf-api-action!

If you are experiencing issues, have questions, or need assistance, please follow the guidelines below to get the help you need.

Before You Ask for Help

Before reaching out for support, please make sure you have done the following:

  • Check Documentation: Review the project's documentation to see if your question is addressed there.

  • Search Issues: Look through existing GitHub issues to see if someone else has reported a similar problem or if there is a discussion that might help.

  • Update to Latest Version: Ensure that you are using the latest release of the project. Sometimes, issues may have already been fixed in newer versions.

How to Get Support

If you've gone through the steps above and still need assistance, you can get support through the following channels:

  1. GitHub Issues: For bug reports, feature requests, and general discussions, please use the GitHub issues page.

  2. Email Support: If you prefer, you can also reach out via email at ori75660@gmail.com.

Reporting Issues

When reporting issues, please provide the following information:

  • Version: Specify the version of the project you are using.

  • Environment: Provide details about your operating system, browser, or any other relevant environment information.

  • Reproduction Steps: Clearly outline the steps to reproduce the issue.

  • Expected vs Actual Behavior: Describe what you expected to happen and what actually happened.

  • Screenshots: If applicable, include screenshots or code snippets that help illustrate the issue.

Feature Requests

If you have a feature request, please open a GitHub issue and use the "enhancement" label. Provide as much detail as possible about the new feature you are proposing.

Contribution

Contributions to the drf-api-action library are welcome. If you would like to contribute, please follow these steps:

  1. Fork the drf-api-action repository on GitHub.

  2. Create a new branch for your feature or bug fix.

  3. Make the necessary changes and additions.

  4. Write tests to cover the new functionality or bug fix.

  5. Run the existing tests to ensure all tests pass successfully.

  6. Run pre-commit tool before pushing to align code to our standards.

  7. Commit your changes and push them to your forked repository.

  8. Open a pull request on the original drf-api-action repository and provide a detailed description of your changes based on pull request template.

The maintainers will review your pull request, provide feedback, and work with you to merge the changes into the main repository.

Thank you for considering contributing to drf-api-action!

Community and Discussion

Join our community to connect with other users and discuss the project:

Feel free to ask questions, share your experiences, and collaborate with others.

Thank you for using drf-api-action! We appreciate your support and contributions.

Happy coding!