Contribution

Contributing to NXTU (NeXT reUsable)

We welcome contributions to NXTU (NeXT reUsable)! Here are some guidelines to help you get started.

How to Contribute

Reporting Issues

If you encounter a bug, have a question, or want to request a new feature, please open an issue on our GitHub repository. Be sure to provide as much detail as possible so that we can address your report effectively.

Forking the Repository

1. Fork the repository by clicking the "Fork" button at the top right of the GitHub page.

2. Clone your fork to your local machine:

   git clone https://github.com/your-username/nxtu.git

3. Add the original repository as a remote:

   git remote add upstream https://github.com/nxtopen/nxtu.git

Creating a Branch

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

   git checkout -b my-feature-branch

Making Changes

1. Make your changes in the new branch.

2. Ensure your code adheres to the project's coding standards.

3. Write tests for your changes if applicable.

Committing Changes

1. Commit your changes with a descriptive commit message:

   git add .
   git commit -m "Description of changes"

Pushing Changes

1. Push your changes to your forked repository:

   git push origin my-feature-branch

Creating a Pull Request

1. Navigate to the original repository on GitHub.

2. Click the "New pull request" button.

3. Select the branch you just pushed from your forked repository.

4. Provide a clear description of the changes and why they are necessary.

5. Submit the pull request.

Coding Standards

• Follow the existing code style.

• Write clear, concise comments in your code.

• Use meaningful variable and function names.

• Keep functions and classes small and focused.

Testing

• Ensure your code passes all existing tests.

• Add new tests to cover your changes.

• Run tests locally to verify your changes.

Documentation

• Update the documentation to reflect your changes.

• Ensure that new components are documented with usage examples.

Code of Conduct

By participating in this project, you agree to abide by the NXTU Code of Conduct.

Contact

If you have any questions or need further assistance, feel free to contact the project maintainers.

Thank you for contributing to NXTU (NeXT reUsable)!