Skip to content

Latest commit

 

History

History
91 lines (51 loc) · 4.14 KB

CONTRIBUTING.md

File metadata and controls

91 lines (51 loc) · 4.14 KB

🌟 Contributing to TrustAuthX 🌟

Thank you for considering contributing to our open-source project! Your interest is much appreciated, and we welcome your valuable assistance in enhancing our project. 🙌

Table of Contents 📜

To become an official contributor to TrustAuthX, please follow these steps and register yourself in the organization's clabot-config public repository. This process helps maintain a record of official contributors, validate contributions, and provides exclusive benefits. 📜

Registration Process 📝

  1. Navigate to the clabot-config public repository within our organization.

  2. Open the .clabot file and append your GitHub username in JSON format. Then, proceed to create a pull request.

Contributor License Agreement (CLA) 🖋️

When you create a pull request for the first time, you'll encounter a request from a bot to approve the Contributor License Agreement (CLA). To complete this step, follow these instructions:

  1. Copy the text from the comment of the cla assistant bot that says, "I have read the CLA Document and I hereby sign the CLA."

  2. Paste this text in the next comment.

Completing this CLA step is crucial to being added to the official contributor list and enjoying other contributor perks. Don't miss out! 🚀

Getting Started 🏁

  • Ensure you have a GitHub account. ✅
  • Fork the repository on GitHub. 🍴

Code of Conduct 📜

We expect all contributors to adhere to our Code of Conduct. Please take a moment to review and follow it. 🤝

How to Contribute 🤓

  1. Create an Issue: If you spot a bug, have a feature request, or wish to discuss changes, kindly open an issue on our GitHub repository. This helps us track and engage with your suggestions. 📝

  2. Fork the Repository: Click the "Fork" button in 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 with a descriptive name, e.g., feature/my-new-feature or bugfix/issue-123. 🌿

  5. Make Changes: Implement your changes in your branch. Ensure your code is clean and maintainable. 🧹

  6. Test: Verify that your changes do not disrupt existing functionality. Run tests if available. ✅

  7. Commit: Commit your changes with a clear and concise 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 comprehensive description of your changes. 🛠️

Reporting Bugs 🐞

If you come across a bug, please follow these steps:

  1. Check the existing issues to see if the bug has already been reported. 🧐

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

Feature Requests 🌟

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

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

Pull Requests 🛠️

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

Development Setup 💻

For assistance with setting up the development environment, please refer to our Discord Server and ask your questions. Our community is here to help! 🤖

License 📃

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