Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

51 lines (33 loc) · 2.27 KB
Raw

Contributing to Starwar-Archive

Thank you for considering contributing to Starwar-Archive! We welcome contributions from the community to make this project better.

Please take a moment to review this document to understand how to contribute effectively.

Code of Conduct

We expect all contributors to abide by our Code of Conduct. Please read it carefully before making any contributions.

Getting Started

Before you start contributing, ensure that you have:

  1. Node.js installed (version 18.x.x).
  2. Cloned the repository.

Setting Up the Project

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Install the project dependencies by running npm install.
  4. Start the development server using npm run dev.

Making Changes

  1. Create a new branch for your feature or bug fix: git checkout -b feature/my-feature or git checkout -b bugfix/issue-number.
  2. Make your changes and ensure that the code follows the project's coding standards and guidelines.
  3. Write tests for any new functionality or changes.
  4. Run tests using npm test to ensure that they pass.
  5. Commit your changes using descriptive commit messages: git commit -m "feat: added new feature" or git commit -m "fix: resolved issue #123".
  6. Push your changes to your forked repository: git push origin feature/my-feature or git push origin bugfix/issue-number.

Submitting a Pull Request

  1. Open a pull request against the main branch of the original repository.
  2. Ensure your pull request includes a clear title and description of the changes you made.
  3. Provide any additional information or context that could help with the review process.
  4. Request reviews from maintainers or specific contributors, if needed.

Code Reviews

All contributions will go through code reviews. Be prepared to make any necessary changes based on the feedback received.

Additional Resources

Thank you for contributing to Starwar-Archive!