Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 1.66 KB

CONTRIBUTING.md

File metadata and controls

53 lines (35 loc) · 1.66 KB
Raw

Contributing to Vigil 🧪

Thank you for considering contributing to Vigil! Your help is invaluable in keeping this project up-to-date and useful for the community.

The following guidelines will help you understand how to contribute effectively.

📝 Reporting Issues

If you find a bug or an issue, please create a new issue on the GitHub repository with the following information:

  1. A clear and descriptive title
  2. A detailed description of the issue
  3. Steps to reproduce the issue, if applicable
  4. The expected behavior and the actual behavior
  5. Any additional information that might help troubleshoot the issue

🛠️ Submitting Pull Requests (PRs)

  1. Fork the Vigil repository and clone your fork to your local machine.

  2. Create a new branch for your changes:

git checkout -b your-feature-branch
  1. Make your changes and commit them to your branch:
git add .
git commit -m "Your commit message"
  1. Push your changes to your fork:
git push origin your-feature-branch
  1. Create a new Pull Request (PR) against the upstream repository:
  • Go to the Vigil repository on GitHub
  • Click the "New Pull Request" button
  • Choose your fork and your feature branch
  • Add a clear and descriptive title and a detailed description of your changes
  • Submit the Pull Request

📖 Updating Documentation

If you find any errors or gaps in the documentation, or if you have suggestions for improvements, feel free to create a new issue or submit a PR with your proposed changes.

Thank you for contributing to Vigil! 🚀