Skip to content

Latest commit

 

History

History
88 lines (49 loc) · 4.06 KB

CONTRIBUTING.md

File metadata and controls

88 lines (49 loc) · 4.06 KB

Contributing to BaseApp

Thank you for your interest in contributing to BaseApp! We welcome contributions from the community to help improve and grow the project. Please take a moment to review these guidelines before getting started.

Table of Contents

Reporting Bugs

When you encounter a bug or unexpected behavior in BaseApp, please follow these steps to report it:

  1. Check the GitHub Issues to ensure that the bug hasn't already been reported.

  2. If the issue hasn't been reported, create a new issue by clicking on the "New Issue" button. Please make sure to use the bug label when creating feature requests to help categorize and prioritize them effectively.

  3. Use a clear and descriptive title and provide detailed information about the issue, including steps to reproduce it and any error messages or logs.

  4. If possible, include any relevant code snippets or configuration files that can help in diagnosing the problem.

  5. Assign appropriate labels and milestones to the issue, if you have access.

Requesting Features

If you have an idea for a new feature or enhancement in BaseApp, please follow these steps to request it:

  1. Check the GitHub Issues to ensure that the feature hasn't already been requested.

  2. If the feature hasn't been requested, create a new issue by clicking on the "New Issue" button. Please make sure to use the enhancement label when creating feature requests to help categorize and prioritize them effectively.

  3. Use a clear and descriptive title and provide detailed information about the feature request, including its use case and benefits.

  4. If possible, include any design or implementation suggestions you may have.

  5. Assign appropriate labels and milestones to the issue, if you have access.

Contributing Code

We welcome code contributions to BaseApp! To contribute code, please follow these steps:

  1. Fork the BaseApp repository to your GitHub account.

  2. Clone your forked repository to your local development environment.

  3. Create a new branch for your feature or bug fix. If it is tied to a Jira ID, please use the format BA-<JIRA-ID>-feature-name for your branch name. If it's not tied to a Jira ID, you can simply use the format BA-feature-name:

    git checkout -b BA-feature-name

  4. Make your changes, write tests if applicable, and ensure that the existing tests pass.

  5. Commit your changes with a clear and concise commit message. If it is tied to a Jira ID, please use BA-<JIRA-ID>: as a prefix. If it's not tied to a Jira ID, you can simply use the prefix BA::

    git commit -m "BA: Your feature description"

  6. Push your changes to your forked repository:

    git push origin BA-feature-name

  7. Open a Pull Request (PR) against the master branch of the BaseApp repository.

  8. Provide a descriptive PR title and include details about the changes you've made.

  9. Participate in the PR review process, addressing any feedback or comments.

  10. Once your PR is approved and passes continuous integration checks, it will be merged into the master repository.

  11. Before submitting your PR, please make sure you have read and understood the versioning section in the README.

Code of Conduct

Please note that by contributing to BaseApp, you are expected to adhere to our Code of Conduct. We want all contributors to maintain a respectful and inclusive environment for everyone.

Thank you for your interest in contributing to BaseApp! Your contributions are greatly appreciated, and they help make the project better for everyone.

If you have any questions or need further assistance, feel free to reach out to us on the GitHub issue tracker or by contacting us.

Happy coding! 🚀