Contributing to CybMASDE
Thank you for your interest in contributing to CybMASDE! We welcome contributions from the community and appreciate your help in making this project better. Please follow the guidelines below to ensure a smooth contribution process.
How to Contribute
-
Fork the Repository: Start by forking the repository on GitHub. This will create a copy of the project under your GitHub account.
-
Clone Your Fork: Clone your forked repository to your local machine using:
git clone https://github.com/your-username/cybmasde-docs.git -
Create a Branch: Create a new branch for your feature or bug fix:
git checkout -b my-feature-branch -
Make Changes: Make your changes in the codebase. Ensure that your code adheres to the project's coding standards.
-
Test Your Changes: Run tests to verify that your changes work as expected and do not break existing functionality.
-
Commit Your Changes: Commit your changes with a clear and descriptive commit message:
git commit -m "Add a new feature or fix a bug" -
Push to Your Fork: Push your changes to your forked repository:
git push origin my-feature-branch -
Create a Pull Request: Go to the original repository on GitHub and create a pull request from your branch. Provide a clear description of your changes and why they should be merged.
Coding Standards
- Follow the existing code style and conventions used in the project.
- Write clear and concise comments in your code.
- Ensure that your code is well-documented.
Reporting Issues
If you encounter any issues or bugs, please report them by opening an issue in the GitHub repository. Provide as much detail as possible, including steps to reproduce the issue.
Thank You!
We appreciate your contributions and support for CybMASDE! Together, we can make this project even better.