Update CONTRIBUTING.md

This commit is contained in:
Sebastian Palencsár
2025-01-22 09:14:22 +01:00
committed by GitHub
parent 5ecb235919
commit f7d20d1619

View File

@@ -1,25 +1,59 @@
# Contributing # Contributing to NAS Setup Script
Thank you for considering contributing to this project! Here are some guidelines to help you contribute. First off, thank you for considering contributing to this project. Your help is essential for keeping it great.
## How to Contribute ## How to Contribute
1. Fork the repository. ### Reporting Bugs
2. Create a new branch (`git checkout -b feature-branch`).
3. Make your changes and commit them (`git commit -am 'Add new feature'`).
4. Push the branch (`git push origin feature-branch`).
5. Create a new Pull Request.
## Code Guidelines If you find a bug, please report it by opening an issue on the [GitHub Issues](https://github.com/noordjonge/nasscript/issues) page. Please include:
- Ensure your code is well-documented. - A clear and descriptive title
- Follow the existing code style. - A detailed description of the issue
- Write tests for your changes if possible. - Steps to reproduce the issue
- Any relevant logs or screenshots
## Reporting Issues ### Suggesting Enhancements
If you find a bug, please report it in the [Issue Tracker](https://github.com/noordjonge/nasscript/issues). If you have an idea for an enhancement, please open an issue on the [GitHub Issues](https://github.com/noordjonge/nasscript/issues) page. Please include:
- A clear and descriptive title
- A detailed description of the enhancement
- Any relevant examples or use cases
### Pull Requests
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
### Code Style
Please ensure your code adheres to the following guidelines:
- Follow the existing code style
- Write clear and concise comments
- Ensure your code is well-documented
- Test your changes thoroughly
### Testing
Before submitting a pull request, please ensure that your changes do not break any existing functionality. Run the script and verify that all features work as expected.
### Documentation
If your changes affect the usage or functionality of the script, please update the relevant documentation in the `README.md` and any other relevant files.
## Code of Conduct
By participating in this project, you agree to abide by the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/).
## License ## License
By contributing, you agree that your contributions will be licensed under the MIT License. By contributing to this project, you agree that your contributions will be licensed under the MIT License.
## Acknowledgments
Thank you for your contributions and for helping to improve this project!