Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (35 loc) · 2.63 KB

CONTRIBUTING.md

File metadata and controls

54 lines (35 loc) · 2.63 KB
Raw

Contributing

We welcome contributions to Usernaut! If you find a bug, have a feature request, or want to contribute code, please follow these steps:

  1. Fork the Repository: Create a fork of the Usernaut repository on GitHub.

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

    git checkout -b feature/my-feature

  3. Make Changes: Implement your changes and ensure they are well-tested.

  4. Commit Your Changes: Commit your changes with a descriptive commit message:

    git commit -m "Add my feature"

  5. Push to Your Fork: Push your changes to your forked repository:

    git push origin feature/my-feature

  6. Create a Pull Request: Open a pull request against the main branch of the Usernaut repository. Provide a clear description of your changes and why they are needed.

  7. Review Process: Your pull request will be reviewed by the Usernaut maintainers. They may request changes or provide feedback.

  8. Address Feedback: If changes are requested, make the necessary updates in your branch and push the changes. The pull request will automatically update.

  9. Merge: Once your pull request is approved, it will be merged into the main branch.

  10. Celebrate: Congratulations! You've contributed to Usernaut.

License

Usernaut is licensed under the Apache License 2.0. See the LICENSE file for more details.

Contact

For any questions, issues, or feedback, please open an issue on the GitHub repository or contact the maintainers via email.

Acknowledgments

Usernaut is built on the shoulders of many open-source projects and communities. We would like to acknowledge the contributions of the Kubernetes community, Operator SDK, and all the contributors who have made this project possible.

Future Work

As Usernaut continues to evolve, we have several planned features and improvements:

  • Support for Additional SaaS Platforms: Expanding the list of supported SaaS platforms to include more services.
  • Group Inheritance: Implementing group inheritance to allow for more flexible user management. (Note: query-based groups via spec.members.ldap_query are already supported.)
  • Monitoring and Metrics: Integrating monitoring and metrics to provide insights into the operator's performance and resource usage.
  • Enhanced Error Handling: Improving error handling and reporting to make it easier to diagnose issues.

Community and Support

We encourage community involvement in the development of Usernaut. If you have ideas, suggestions, or want to contribute, please join our discussions on GitHub or reach out via email.