diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..34850b4 --- /dev/null +++ b/contributing.md @@ -0,0 +1,60 @@ +# Contributing to Historo + +Thank you for your interest in contributing to **Historo: The History of Everything**! We appreciate your help in building and expanding our open source webapp. Here's a guide to help you get started with contributing to this project. + +## Table of Contents + +- [Code of Conduct](#code-of-conduct) +- [How to Contribute](#how-to-contribute) +- [Reporting Issues](#reporting-issues) +- [Submitting Code](#submitting-code) +- [Documentation](#documentation) +- [Development Guidelines](#development-guidelines) +- [Additional Resources](#additional-resources) + +## Code of Conduct + +Please review and adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a respectful and productive environment for all contributors. + +## How to Contribute + +### Reporting Issues + +If you find a bug or have a suggestion for improvement, please open an issue on our [issue tracker](https://github.com/prakhartiwari0/Historo/issues). When reporting an issue, be sure to include: + +- A clear and descriptive title +- Steps to reproduce the issue +- The expected behavior +- The actual behavior +- Any relevant screenshots or error messages + +### Submitting Code + +We welcome code contributions! To contribute code: + +1. **Fork the repository**: Click the "Fork" button at the top right of the repository page on GitHub. +2. **Clone your fork**: `git clone https://github.com/YOUR_USERNAME/Historo.git` +3. **Create a new branch**: `git checkout -b your-branch-name` +4. **Make your changes**: Implement your improvements or bug fixes. +5. **Commit your changes**: `git commit -am 'Add some feature'` +6. **Push to your fork**: `git push origin your-branch-name` +7. **Create a pull request**: Go to the original repository and click "New Pull Request." Select your branch and describe your changes. + +### Documentation + +If you want to help with documentation, please update the relevant Markdown files in the `docs` directory or create new ones if necessary. Ensure that any changes made to the documentation are clear, concise, and useful to the users. + +## Development Guidelines + +- **Code Style**: Follow the coding style used in the project. Consistent formatting makes it easier to read and maintain the code. +- **Testing**: Ensure that your code changes do not break existing functionality. Add new tests if necessary and run all tests before submitting a pull request. +- **Commit Messages**: Write clear and descriptive commit messages. Follow the format: `type: short description` (e.g., `fix: correct typo in documentation`). + +## Additional Resources + +- [GitHub Guides](https://guides.github.com/) +- [Git Cheat Sheet](https://education.github.com/git-cheat-sheet-education.pdf) +- [Markdown Guide](https://www.markdownguide.org/) + +Thank you for contributing to **Historo**! Your efforts help make our project better and more comprehensive. +