Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
80 lines (55 loc) · 4.03 KB

CONTRIBUTING.md

File metadata and controls

80 lines (55 loc) · 4.03 KB
Raw

Contributing

We welcome contributions to this project! By participating, you agree to abide by our Code of Conduct.

How to Contribute

Here are several ways you can contribute to this project:

  • Report Bugs: Help us find and fix issues by reporting them!
  • Suggest Enhancements: Do you have an idea for a new feature or improvement? Let us know!
  • Write Code: Contribute directly by submitting pull requests.
  • Improve Documentation: Help us make the documentation clearer and more helpful.
  • Spread the Word: Tell others about this project and encourage them to contribute!

Reporting Bugs

Before submitting a bug report, please:

  • Search Existing Issues: Check if the issue has already been reported.
  • Reproduce the Bug: Ensure you can reliably reproduce the bug.
  • Provide Clear Steps: Clearly describe how to reproduce the bug.
  • Include Relevant Information: Include details such as your operating system, browser version, software versions, and any error messages.

To report a bug, create a new issue on GitHub:

  1. Go to the Issues tab.
  2. Click "New Issue".
  3. Choose the "Bug Report" template (if available) or provide the necessary information in your own format.

Suggesting Enhancements

We appreciate your ideas for improving this project! When suggesting an enhancement:

  • Explain the Benefit: Clearly describe the problem the enhancement solves or the benefit it provides.
  • Consider Alternatives: Briefly consider alternative solutions or approaches.
  • Provide Context: Explain how the enhancement would fit into the existing project.

To suggest an enhancement, create a new issue on GitHub:

  1. Go to the Issues tab.
  2. Click "New Issue".
  3. Choose the "Feature Request" template (if available) or provide the necessary information in your own format.

Contributing Code

Here's how to contribute code to this project:

  1. Fork the Repository: Create your own copy of the repository.
  2. Create a Branch: Create a new branch for your changes. Name it something descriptive, like feature/new-feature or bugfix/fix-issue-123.
  3. Make Changes: Implement your changes, following the project's coding style and guidelines.
  4. Write Tests: Add tests to verify your changes work as expected.
  5. Run Tests: Ensure all tests pass before submitting a pull request.
  6. Commit Changes: Commit your changes with clear and concise commit messages. Follow the Conventional Commits specification if possible.
  7. Push Changes: Push your branch to your forked repository.
  8. Create a Pull Request: Submit a pull request to the main repository.

Pull Request Guidelines

  • One Feature/Fix per PR: Keep pull requests focused on a single feature or bug fix.
  • Clear Description: Provide a clear and concise description of the changes in your pull request.
  • Linked Issue: If your pull request addresses an existing issue, link to it in the description (e.g., "Fixes #123").
  • Code Style: Follow the project's coding style and guidelines. Use a linter or formatter if one is configured.
  • Tests: Include tests to verify your changes work as expected.
  • Review: Be responsive to feedback and address any concerns raised during the review process.

Setting up your Development Environment

(This section should be adapted to your specific project's needs. Example using Node.js:)

To get started developing, you'll need to install:

Then, clone the repository and install the dependencies:

git clone https://github.com/dev-leva1/animeportal.git  
cd animeportal  
npm install  # or yarn install