Skip to content

Latest commit

 

History

History
75 lines (45 loc) · 2.81 KB

contributions.md

File metadata and controls

75 lines (45 loc) · 2.81 KB
Raw

Contributing to TrustAuthX & Guidelines for contributing to TrustAuthX.

Contributing to TrustAuthX

Thank you for considering contributing to our open-source project! We appreciate your interest and welcome your help in making our project better.

Table of Contents

Getting Started

Code of Conduct

We expect all contributors to follow our Code of Conduct. Please make sure you review and adhere to it.

How to Contribute

  1. Create an Issue: If you find a bug, have a feature request, or want to discuss any changes, please create an issue on our GitHub repository. This helps us track and discuss your suggestions.

  2. Fork the Repository: Click the "Fork" button on the top right corner of the repository's page to create your own copy.

  3. Clone your Fork: Clone your forked repository to your local machine using git clone.

  4. Create a Branch: Create a new branch for your work. Use a descriptive branch name, e.g., feature/my-new-feature or bugfix/issue-123.

  5. Make Changes: Make your changes in your branch. Write clean and maintainable code.

  6. Test: Ensure that your changes do not break existing functionality. Run tests if they are available.

  7. Commit: Commit your changes with a clear and concise commit message.

  8. Push: Push your changes to your fork on GitHub.

  9. Create a Pull Request (PR): Open a pull request from your fork to our repository. Provide a detailed description of your changes.

Reporting Bugs

If you find a bug, please follow these steps:

  1. Search the existing issues to check if the bug has already been reported.

  2. If not, create a new issue. Include a clear title and description of the bug, steps to reproduce it, and any relevant information.

Feature Requests

If you have an idea for a new feature or enhancement, please create an issue with the following information:

  • Clear title and description.
  • The problem or need the feature addresses.
  • Any specific implementation ideas (optional).

Pull Requests

We welcome pull requests that fix bugs or add new features. Follow the steps mentioned in the "How to Contribute" section to submit a PR.

Development Setup

If you need help setting up the development environment, please refer to the Development Setup guide.

License

By contributing to this project, you agree that your contributions will be licensed under our project's LICENSE.