PixelRidge-Softworks/NETRAVE
PixelRidge-Softworks/NETRAVE
3
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
main
NETRAVE/CONTRIBUTING.md
VetheonGames 5d313a7d5e
Create CONTRIBUTING.md 
Signed-off-by: VetheonGames <76892542+VetheonGames@users.noreply.github.com>
2023-06-05 15:46:49 -06:00

2.9 KiB
Raw Permalink Blame History

Contributing Guidelines for NETRAVE

Firstly, thank you for your interest in contributing to the NETRAVE project! We appreciate your time and effort to make this project better. Here are some guidelines to help you along the way.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please take a moment to read it before starting work.

How to Contribute

  1. Fork the Repository: Start by forking the NETRAVE repository to your own GitHub account. This allows you to freely experiment with your ideas without affecting the original project.

  2. Clone the Repository: Once you have forked the repository, you can clone it to your local machine and start making changes.

  3. Create a New Branch: We use a branch-based development workflow, so changes should be made on a new branch in your forked repository. The branch name should be descriptive of the changes you plan to make.

  4. Make Your Changes: Make the changes you want to contribute. Be sure to follow the coding standards and conventions used in the rest of the project.

  5. Test Your Changes: Ensure that your changes do not break any existing functionality and that any new features work as expected.

  6. Commit Your Changes: Commit your changes to your branch. Commit messages should be clear and descriptive of the changes you made.

  7. Push Your Changes: Push your changes to your forked repository on GitHub.

  8. Submit a Pull Request: From your forked repository, submit a pull request to the main NETRAVE repository. In the pull request description, explain the changes you made, why you made them, and any other information that might be helpful.

Pull Request Review

Once you submit a pull request, it will be reviewed by the maintainers of the NETRAVE project. They may ask you to make changes or provide more information about your changes. Please be patient during this process and provide any requested information.

Coding Standards

Please follow the coding standards and conventions used throughout the project. This includes proper indentation, clear and descriptive variable names, and comprehensive comments.

Reporting Bugs

If you find a bug in the project, please report it by creating a new issue in the GitHub repository. Be sure to include as much information as possible, such as how to reproduce the bug and any error messages you received.

Requesting Features

If you have an idea for a new feature, you can request it by creating a new issue in the GitHub repository. Describe the feature you would like to see, why it would be useful, and how it should work.

Questions

If you have any questions about contributing to the NETRAVE project, please feel free to ask. You can create a new issue in the GitHub repository or contact the maintainers directly.

Thank you again for your interest in contributing to the NETRAVE project. We look forward to seeing your contributions!