Skip to content

Latest commit

 

History

History
24 lines (19 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

24 lines (19 loc) · 1.37 KB

Contributing to Fil - Microbial File Storage

This is a hobby project of mine that I have spent quite a lot of time on, mainly just pouring through AWS documentation. It was a chance for me to learn more about Serverless and configuration as code, and I hope the documentation provided can be useful for someone else. Contributions are always welcome however, where it's

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase. Pull requests are welcome!

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs or added new features, update the documentation. This repository is designed for learning so be as detailed as possible and update/add the relevant sections in README and ARCHITECTURE.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request 🚀

License

By contributing, you agree that your contributions will be licensed under its MIT License.

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft