From f315cdfb5e24eac22c60d9b5483c0806f694f748 Mon Sep 17 00:00:00 2001 From: Alejandro Amaral Date: Sun, 14 Apr 2024 09:36:40 -0300 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..95d92612 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,49 @@ +# Contributing to Tokyo Night Tmux + +Thank you for your interest in contributing to Tokyo Night Tmux! We welcome contributions from the community to help improve and enhance our project. To ensure a smooth collaboration process, please follow the guidelines outlined in this document. + +## Getting Started + +1. Fork the repository on GitHub. +2. Clone your forked repository to your local machine. +3. Create a new branch from the `next` branch for your contribution. + +## Contribution Workflow + +1. **Open an Issue** + - Before starting any work, please open an issue on the GitHub repository describing the feature, bug fix, or improvement you want to contribute. + - Clearly explain the problem or motivation behind your contribution. + - Wait for feedback from the maintainers and ensure that your proposed contribution aligns with the project's goals and roadmap. + +2. **Create a Pull Request** + - Once you have opened an issue and received approval to proceed, you can start working on your contribution. + - Create a new branch from the `next` branch with a descriptive name related to your contribution. + - Make your changes, following the project's coding style and conventions. + - Commit your changes with a clear and concise commit message. + - Push your branch to your forked repository. + - Open a pull request (PR) from your branch to the `next` branch of the main repository. + - In the PR description, reference the issue number you opened earlier (e.g., "Fixes #123" or "Resolves #456"). + - Provide a detailed description of your changes and the problem they solve. + +3. **Code Review** + - The maintainers will review your pull request and provide feedback. + - Be responsive to any comments or suggestions and make the necessary changes. + - Once your PR receives approval, it will be merged into the `next` branch. + +## Important Considerations + +- All contributions must be made against the `next` branch. PRs submitted to other branches will not be accepted. +- Ensure that your code follows the project's coding style and conventions. +- Write clear, concise, and meaningful commit messages. +- If your contribution introduces new features or modifies existing ones, please update the relevant documentation. +- Be respectful and considerate towards other contributors and maintainers. + +## Code of Conduct + +By participating in this project, you are expected to uphold our [Code of Conduct](CODE_OF_CONDUCT.md). Please read it to understand the expectations we have for everyone who contributes to this project. + +## License + +By contributing to this project, you agree that your contributions will be licensed under the MIT license. + +Thank you for your contributions and happy coding!