Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

45 lines (29 loc) · 1.84 KB
Raw

Contributing to Sendrr

👍 First off, thank you for considering contributing to Sendrr! 👍

The following is a set of guidelines for contributing to Sendrr. These are just guidelines, not rules, so use your best judgment and feel free to propose changes to this document in a pull request.

How to Contribute

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your feature or bug fix: git checkout -b feature/new-feature or git checkout -b bugfix/fix-issue.
  4. Make your changes and commit them: git commit -m 'Your commit message'.
  5. Push the changes to your forked repository: git push origin feature/new-feature.
  6. Open a pull request against the main branch of the original repository.

Development Setup

To set up a local development environment, follow these steps:

  1. Clone the repository: git clone https://github.com/DevEmmy/sendrr..git.
  2. Install dependencies: npm install.
  3. Start the application: npm start.
  4. To run the backend server: npm start and it runs on port 3030

Coding Standards

Please adhere to the coding standards defined in the project. If none are defined, follow general best practices for the programming language.

Testing

Ensure that your changes do not break existing functionality. If applicable, add new tests to cover your changes.

Pull Request Guidelines

  1. Provide a descriptive title for your pull request.
  2. Include a summary of the changes and the problem it solves.
  3. Reference any relevant issues or pull requests.
  4. Include screenshots or code snippets if necessary.
  5. Ensure that your branch is up to date with the latest changes from the main branch.

Questions and Support

If you have any questions or need support, open an issue on the GitHub repository.

Thank you for your contribution! 🎉