Skip to content

Latest commit

 

History

History
121 lines (74 loc) · 4.44 KB

CONTRIBUTING.md

File metadata and controls

121 lines (74 loc) · 4.44 KB
Raw

Contributing

We are open to, and grateful for, any contributions made by the community. By contributing to Taskany, you agree to abide by the code of conduct.

Reporting Issues and Asking Questions

Before opening an issue, please search the issue tracker to make sure your issue hasn't already been reported.

Bugs and Improvements

We use the issue tracker to keep track of bugs and improvements to Taskany itself, its examples, and the documentation. We encourage you to open issues to discuss improvements, architecture, theory, internal implementation, etc. If a topic has been discussed before, we will ask you to join the previous discussion.

As Taskany is stable software, changes to its behavior are very carefully considered.

Getting Help

For support or usage questions like “how do I do X with Taskany” and “my code doesn't work”, please search and ask on Discussion first.

Some questions take a long time to get an answer. If your question gets closed or you don't get a reply on Discussion for longer than a few days, we encourage you to post an issue linking to your question. We will close your issue but this will give people watching the repo an opportunity to see your question and reply to it on Discussions if they know the answer.

Please be considerate when doing this as this is not the primary purpose of the issue tracker.

Help Us Help You

On both websites, it is a good idea to structure your code and question in a way that is easy to read to entice people to answer it. For example, we encourage you to use syntax highlighting, indentation, and split text in paragraphs.

Please keep in mind that people spend their free time trying to help you. You can make it easier for them if you provide versions of the relevant libraries and a runnable small project reproducing your issue. You can put your code on JSBin or, for bigger projects, on GitHub. Make sure all the necessary dependencies are declared in package.json so anyone can run npm install && npm start and reproduce your issue.

Development

Visit the issue tracker to find a list of open issues that need attention.

Requirements:

  • NodeJS. The best usage experience with NVM. You can find recommended NodeJS version in the .nvmrc.
  • Docker and Docker Compose. Follow official docs to install it.

Fork, then clone the repo:

git clone git@github.com:taskany-inc/issues.git

Install dependencies and prepare env:

npm ci
cp .env.example .env

Add your settings to .env file. Then prepate database:

npm run dev:db:run
npm run dev:db:init
npm run dev

Point your browser to http://localhost:3000 🎉

Testing and Linting

Run linting

npm run lint

Run unit tests

npm run test

Run e2e

npm run test:e2e

NB: dev server must be stopped.

Run e2e with Cypress UI and watch mode

In one terminal tab start environment:

npm run test:e2e

In another:

cypress open

Docs

Improvements to the documentation are always welcome. You can find them in the docs path.

Sending a Pull Request

For non-trivial changes, please open an issue with a proposal for a new feature or refactoring before starting on the work. We don't want you to waste your efforts on a pull request that we won't want to accept.

On the other hand, sometimes the best way to start a conversation is to send a pull request. Use your best judgement!

In general, the contribution workflow looks like this:

  • Open a new issue in the Issue tracker;
  • Fork the repo;
  • Create a new branch based off the master branch. Branch name must follow pattern issues/{id};
  • Make sure all checks pass w/o errors;
  • Make sure PR title equal with issue title w/o issue id;
  • Follow instructions in PR template;
  • Submit a pull request and wait to review.

Please try to keep your pull request focused in scope and avoid including unrelated commits.

After you have submitted your pull request, we'll try to get back to you as soon as possible. We may suggest some changes or improvements.

Thank you for contributing!