Skip to content

Latest commit

 

History

History
61 lines (32 loc) · 3.53 KB

CONTRIBUTING.md

File metadata and controls

61 lines (32 loc) · 3.53 KB

Contributing to Worldwide News App

Thank you for your interest in contributing to [Worldwide News App]! We are excited to welcome new contributions and collaborate with the community.

To contribute to the project, please follow the steps below:

Submitting an Issue

If you encounter a problem or want to propose a new feature, please first check if a similar issue already exists in our issue tracker. If it doesn't exist, you can create a new issue by providing relevant details, including steps to reproduce the problem or a clear description of the proposed new feature.

Cloning the Project

Before you start working on a contribution, you first need to clone the repository to your local environment. You can do this by running the following command: git clone https://github.com/jackamrl/worldwide-news-app.git Make sure you have Git installed on your machine.

Installing Dependencies

After cloning the repository, navigate to the project directory and install the necessary dependencies by running the following command: npm install This command will download and install all project dependencies specified in the package.json file.

Making Changes

Once the dependencies are installed, you can start working on your contribution. Here are some guidelines to follow:

  • Create a separate branch from the main branch (dev) for your contribution: git checkout -b branch-name

  • Adhere to the project's coding and style conventions.

  • Make the necessary changes, ensuring to test your code appropriately.

API

Newscatcher is the api we use. Here is the documentation of newscatcher api the documentation. Please use api calls sparingly, as we're only allowed one call quota.

Submitting a Pull Request

Once you have finished your changes, you can submit a Pull Request (PR) for your contribution to be reviewed. Please follow these steps:

  1. Push your local branch to the remote repository: git push origin branch-name. Before pushing your local make sure you're up to date with the main branch by doing git pull origin dev

  2. Go to the repository on GitHub and click the "Compare & pull request" button to create a new PR.

  3. Provide a clear and concise description of your contribution, explaining the changes made and the reason behind them.

  4. Once your PR is submitted, reviewers will review your contribution, perform additional testing if necessary, and provide you with feedback or requests for modifications.

  5. Once your PR is approved and any requested changes are made, it will be merged into the main branch.

Acknowledgements

We appreciate all contributions made to [Worldwide News App]. Your support and ideas help improve the project and make it more robust.

Note: By contributing to this project, you agree to submit your work under the project's license.

If you have any questions or need further assistance, feel free to contact our development team or open an issue to request help.

Thank you again for your interest in [Worldwide News App], and we look forward to collaborating with you!

Remember to customize this template for your project by adding specific details and additional instructions if necessary.

Please make sure to customize the content by replacing . Worldwide News App, issue tracker, and LICENSE with the specific values relevant to your project.