Skip to content

Latest commit

 

History

History
60 lines (43 loc) · 2.27 KB

contributing.md

File metadata and controls

60 lines (43 loc) · 2.27 KB
Raw

Contributing to AppState

Thank you for considering contributing to AppState! Your contributions help make this project better for everyone.

How to Contribute

1. Reporting Bugs

If you encounter any bugs, please open an issue on GitHub. When reporting a bug, please include:

  • A clear and descriptive title.
  • A detailed description of the bug, including steps to reproduce it.
  • The expected behavior and what actually happened.
  • The version of AppState you are using.
  • Any relevant screenshots or logs.

2. Suggesting Features

New ideas are welcome! If you have a feature you'd like to see added to AppState, please open an issue and describe:

  • The problem the feature would solve.
  • How you think the feature should work.
  • Any additional context or examples that would help illustrate your idea.

3. Submitting Pull Requests

If you'd like to contribute code to AppState, follow these steps:

  1. Fork the Repository: Create a personal fork of the AppState repository on GitHub.
  2. Clone Your Fork: Clone your fork to your local machine: 
    git clone https://github.com/your-username/AppState.git
  3. Create a New Branch: Create a new branch for your feature or bugfix: 
    git checkout -b my-feature-branch
  4. Make Changes: Implement your changes in the new branch.
  5. Test Your Changes: Ensure your changes pass all tests. Add new tests if necessary.
  6. Commit Your Changes: Commit your changes with a descriptive commit message: 
    git commit -m "Add my new feature"
  7. Push to GitHub: Push your branch to your GitHub fork: 
    git push origin my-feature-branch
  8. Create a Pull Request: Go to the AppState repository on GitHub and create a pull request from your branch.

4. Code Style

Please follow the coding style guidelines used in the AppState project. Consistent code style helps make the codebase more maintainable and easier to review.

5. License

By contributing to AppState, you agree that your contributions will be licensed under the same license as the project: LICENSE.

Thank You!

Your contributions are highly valued and appreciated. Thank you for helping improve AppState!