We welcome contributions from the community! Whether you're a researcher, developer, or enthusiast, your input is valuable. Please follow the guidelines below to ensure a smooth contribution process.
Create a folder --:
├── README.md # Project overview and instructions
├── LICENSE # License information
├── src/ # Source code directory
└── docs/ # Documentation directory
we have created a script to generate a boilerplate called boilerplate.sh.
-
Fork the Repository: Click the "Fork" button at the top right of the repository page to create your own copy of the project.
-
Clone Your Fork: Clone your forked repository to your local machine using:
git clone https://github.com/r00thouse/the-network-lab
-
Create a Branch: Create a new branch for your feature or bug fix:
git checkout -b feature/my-project-of-whatever
-
Make Changes: Implement your changes. Ensure that your code adheres to the project's coding standards and style guidelines.
-
Write Tests: If applicable, write tests for your changes to ensure they work as intended.
-
Update Documentation: If your changes affect the documentation, please update it accordingly.
-
Commit Your Changes: Commit your changes with a clear and concise commit message:
git commit -m "Add a brief description of your changes" -
Push to Your Fork: Push your changes to your forked repository:
git push origin feature/your-feature-name
-
Create a Pull Request: Go to the original repository and create a pull request. Provide a detailed description of your changes and why they are necessary.
- Cite Relevant Work: If your contribution is based on existing research, please cite the relevant papers or projects.
- Share Data and Results: If applicable, share any datasets or results that can help others understand your contribution.
- Collaborate: Engage with other contributors and maintainers for feedback and discussions about your contributions.
Please adhere to our Code of Conduct to ensure a welcoming and inclusive environment for all contributors.
Thank you for contributing!