Skip to content

Latest commit

 

History

History
75 lines (47 loc) · 2.66 KB

CONTRIBUTING.md

File metadata and controls

75 lines (47 loc) · 2.66 KB
Raw

Contributing to Starlopost

Thank you for considering contributing to Starlopost! We welcome contributions of all kinds, including new features, bug fixes, documentation improvements, and more. This document provides guidelines and instructions to help you contribute effectively.

Getting Started

  1. Fork the Repository: Fork the Starlopost repository on GitHub to your own account.

  2. Clone the Repository: Clone the forked repository to your local machine.

git clone https://github.com/Kazooki123/starlopost.git

3.Create a Branch: Create a new branch for your work.

git checkout -b <my-feature-branch>

4.Install Dependencies: Install the required dependencies.

npm install .

Making Changes

  1. Code Style: Ensure your code adheres to the project's coding style. We use ESLint for JavaScript linting.

  2. Write Tests: If applicable, write tests for your changes. We use Jest for testing.

  3. Commit Changes: Commit your changes with clear and descriptive messages.

    git add .
git commit -m "Add feature <feature you added>"

  4. Push Changes: Push your changes to your forked repository.

    git push origin <my-feature-branch>

Submitting a Pull Request

  1. Open a Pull Request: Go to the original Starlopost repository and open a pull request from your forked repository.

  2. Describe Your Changes: Provide a detailed description of your changes in the pull request. Mention any issues or bugs your changes address.

  3. Review Process: Your pull request will be reviewed by the project maintainers. They may request changes or provide feedback.

Guidelines

  • Be Respectful: Treat all contributors with respect and consideration. We value a welcoming and inclusive environment.

  • Report Issues: If you encounter a bug or have a feature request, please open an issue on GitHub.

  • Stay Updated: Keep your forked repository up-to-date with the latest changes from the main repository.

    git remote add upstream https://github.com/Kazooki123/starlopost.git
git fetch upstream
git merge upstream/main

Resources

  • Documentation: Refer to the project's documentation for more information on how to use and contribute to Starlopost.
  • Community: Join our community discussions on Github to connect with other contributors and users.

Code of Conduct

Please note that this project adheres to a Code of Conduct. By participating, you are expected to uphold this code.

Thank you for your contributions!