Open sourcing our projects on Github

Our mission is to use technology to help animals and promote animal rights. Open sourcing our projects is one way we strive to achieve this goal. We welcome contributions from others who share our passion and want to help animals through technology.

Contributing Guidelines

Contributing guidelines are a set of rules and instructions that explain how to contribute to a project. They outline the process for submitting issues, creating pull requests, and getting in touch with the maintainers of the project. By following these guidelines, we aim to ensure that all contributions are made in a consistent and manageable way.

1. Create a CONTRIBUTING file that outlines the process for contributing to the project.
2. Mention the contribution guidelines in the README file and include a link to the CONTRIBUTING file.
3. Explain how to file an issue, create a pull request, and get in touch with the maintainers of the project.

License

1. Choose the GNU General Public License v3.0 (GPLv3), which promotes the use of open source software for non-profit purposes.
2. Include the license file in the root directory of the repository.
3. Ensure that all code contributions are made under the same license.

Readme File

1. Create a comprehensive README file that explains the purpose and goals of the project, how to install and use it, and how to contribute to its development.
2. Provide clear instructions for setting up the development environment and any dependencies required.
3. Mention the contribution guidelines and the link to the CONTRIBUTING file.

Documentation

1. Ensure that the code is well-documented and that all functions, classes, and methods have descriptive docstrings.
2. Consider creating additional documentation, such as API documentation or a user manual, to help others understand and use the project.

Tests (Optional)

1. Write automated tests to ensure the reliability and maintainability of the code.
2. Make sure that the tests pass before open sourcing the project.

Security

1. Keep the dependencies of your project up-to-date to prevent known vulnerabilities from being exploited.
2. Consider using tools such as Snyk or OWASP Dependency-Check to scan your dependencies for vulnerabilities.
3. Encourage responsible disclosure of security vulnerabilities through a security.txt file and/or a bug bounty program.

We believe that by open sourcing our projects and encouraging others to contribute, we can help more animals and make a greater impact. We welcome competition in the animal rights technology space, as our ultimate goal is to save as many lives as possible.