Skip to content

Latest commit

 

History

History
48 lines (36 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

48 lines (36 loc) · 2.86 KB
Raw

Contributing

Contributions are made to this repo via Issues and Pull Requests (PRs). A few general guidelines that cover both:

  • Search for existing Issues and PRs before creating your own.
  • We work hard to makes sure issues are handled in a timely manner but, depending on the impact, it could take a while to investigate the root cause. A friendly ping in the comment thread to the submitter or a contributor can help draw attention if your issue is blocking.

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Issues

Issues should be used to report problems with the website, request a new feature, or to discuss potential changes before a PR is created.

When you create a new Issue, a template will be loaded that will guide you through collecting and providing the information we need to investigate.

If you find an Issue that addresses the problem you're having, please add your own reproduction information to the existing issue rather than creating a new one. Adding a reaction can also help be indicating to our maintainers that a particular problem is affecting more than just the reporter.

Pull Request Process

PRs to our website are always welcome and can be a quick way to get your fix or improvement slated for the next release. In general, PRs should:

  • Only fix/add the functionality in question OR address wide-spread whitespace/style issues, not both.
  • Add unit or integration tests for fixed or changed functionality (if a test suite already exists).
  • Address a single concern in the least number of changed lines as possible.
  • Be accompanied by a complete Pull Request template (loaded automatically when a PR is created).

In general, we follow the "fork-and-pull" Git workflow

  1. Fork the repository to your own Github account
  2. Clone the project to your machine by running git clone <repository_url>
  3. Get the required dependencies for your projects with npm i or yarn and run all tests to make sure everything is alright.
  4. Make sure you use prettier and to run the development server use: 
    npm run dev
# or
yarn dev
  5. To keep the forked repo in sync with the main repo do git remote add upstream https://github.com/robin00007/code-verse.git once.
  6. Now, every time before developing some new feature do: 
    git checkout master
git pull upstream master
  7. The above command will sync the forked repo with the main repo.
  8. Create a new branch locally with a succinct but descriptive name for new feature
  9. Commit changes to the branch following any formatting and testing guidelines specific to this repo
  10. Push changes to your fork
  11. Open a PR in our repository and follow the PR template so that we can efficiently review the changes.