CONTRIBUTING.md

Contributing to Nexify

We’re excited that you’re interested in contributing to Nexify! Here are a few guidelines to help you get started.

How to Contribute

1. Fork the Repository: Fork the repository to your GitHub account.
2. Create a New Branch: Create a new branch for your feature or bugfix:

   git checkout -b feature/your-feature-name

3. Make Your Changes: Implement your changes and commit them with clear and descriptive messages.
4. Push to Your Fork: Push your changes to your forked repository:

   git push origin feature/your-feature-name

5. Submit a Pull Request: Open a pull request against the develop branch.

Branching Model

We follow a simplified Git Flow branching strategy:

• main: Contains the stable version of the code.
• develop: Used for ongoing development and should contain the latest features and fixes.
• Feature branches: Create a new branch from develop for your work and merge it back via a pull request.

Coding Standards

• Naming Conventions: Use descriptive and meaningful names for variables, functions, and classes.
• Code Formatting: Follow the project’s code style and format your code before committing.
• Comments: Write clear comments where necessary to explain complex code.

Commit Messages

• Descriptive Messages: Write concise but descriptive commit messages.
• Format: Use the following format for commit messages:

  [Type] Short description of the change
  
  Detailed explanation of what was changed and why, if necessary.
  

Pull Request Checklist

• Code follows the project’s coding standards.
• Code is tested and passes all tests.
• Documentation is updated if necessary.
• All relevant issues are linked in the pull request.

Thank you for your contributions!