Contribution Guidelines

Thanks for your interest in contributing to Lantern.Discv5! Following these guidelines helps to communicate effectively and ensure that your contribution matches our project needs.

Ways To Contribute

There are many ways to contribute, beyond writing code. Here are some possibilities:

• Improve documentation: We welcome updates to our documentation to ensure it remains current, accurate, and clear. Whether it's correcting typos, clarifying instructions, writing new guides, or providing examples, your contributions in this area are greatly appreciated.

• Report a bug: Report any errors you encounter while using our software. This helps us ensure our software runs smoothly and effectively.

• Propose new features: If there's a feature you'd like to see added to our software, feel free to suggest it! We're always open to exploring new ideas.

Steps To Contribute

1. Fork the repository: Head over to the Lantern.Discv5 GitHub repository, and then click the "Fork" button in the upper right corner.

2. Clone the repository to your local machine: You can do this using the following command in your terminal:

git clone https://github.com/Pier-Two/Lantern.Discv5.git

3. Create your feature branch: After switching into your repository (using cd lantern.discv5), create a new branch for your feature:

git checkout -b feature/feature-name

4. Make your changes: Implement your feature, fix a bug, improve documentation, or contribute in another way. Make sure your changes are clean, easy to understand, and well-documented.

5. Commit and push your changes: Once you're done with your feature, you're ready to commit your changes and push them to your Github repository:

git commit -m "Add some feature"
git push origin feature/feature-name

4. Raise a Pull Request: Go back to your repository on GitHub. Click the "New pull request" button, where you'll be able to see and review the changes you've made.