Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (42 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

67 lines (42 loc) · 2.49 KB

Contributing to up

First and foremost, thank you for considering contributing to up. We appreciate the time and effort you're willing to spend on our project. This document provides guidelines to ensure smooth collaboration and productivity for everyone.

Code of Conduct

All contributors are expected to adhere to the project's Code of Conduct. Please familiarize yourself with it before contributing.

How to Contribute

  1. Fork the Repository: Start by forking the up repository to your own GitHub account.

  2. Clone the Repository: Once forked, you can clone the repository to your local machine:

git clone https://github.com/KennethanCeyer/up.git
  1. Set Upstream: Navigate to your local repository and set the original up repository as "upstream":
git remote add upstream https://github.com/KennethanCeyer/up.git
  1. Create a New Branch: For every new feature or bugfix, create a separate branch:
git checkout -b [branch-name]

  1. Make Your Changes: Implement your feature or bugfix.

  2. Push to Your Fork: Once you're satisfied with your changes, push your branch to your fork on GitHub:

git push origin [branch-name]

  1. Create a Pull Request: Navigate to your fork on GitHub and click the "Create a pull request" button. Fill out the template with all the relevant information.

  2. Address Review Comments: If the maintainers have any feedback, address the comments and push the changes to your branch.

Coding Guidelines

  • Ensure you follow the coding standards prevalent in the project.
  • Write clean, readable, and maintainable code.
  • Include comments where necessary.
  • Make sure to write tests for your code if applicable.
  • Update any relevant documentation as needed.

Reporting Issues

If you encounter any issues or have suggestions, please open a new issue on the up GitHub page. When reporting bugs, provide as much information as possible, including steps to reproduce the issue.

Pull Request Process

  1. Ensure that your code complies with the project's coding standards.
  2. Your Pull Request should be free from conflicts with the base branch.
  3. All tests, if present, should pass.
  4. Include a descriptive commit message.
  5. The maintainers will review your PR and provide feedback. Address any comments or suggestions they might have.

License

By contributing to up, you agree that your contributions will be licensed under the Apache License 2.0.

Thank you for your contribution!